pCon.planner Plugin SDK  Version 8.9
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Events
Public Member Functions | Properties | Events | List of all members
X3g::Plugin::Articles::ArticleInstance Class Reference

Article instance. More...

Inheritance diagram for X3g::Plugin::Articles::ArticleInstance:
Inheritance graph
[legend]

Public Member Functions

void Close ()
 Closes the instance and applies all changes. More...
 

Properties

DbEntity^  MainEntity [get]
 The main entity id of this instance. More...
 
DbEntity^  SelectedEntity [get]
 The currently selected entity of this instance. More...
 
PropertyProvider^  Properties [get]
 Provides properties for the currently selected entity. More...
 
bool Valid [get]
 Returns true if this instance is still valid. More...
 

Events

static System::EventHandler^  AnyInstanceOpened [add, remove, raise]
 Fired when an article has been instantiated. More...
 
static System::EventHandler^  AnyInstanceClosing [add, remove, raise]
 Fired when current instance is about to be closed. More...
 
static System::EventHandler^  AnyInstanceClosed [add, remove, raise]
 Fired when an instance has been closed. More...
 

Detailed Description

Article instance.

Member Function Documentation

void X3g::Plugin::Articles::ArticleInstance::Close ( )

Closes the instance and applies all changes.

An instance will be invalid after it was closed. The instance gets automatically closed if another article gets instantiated or if it is deselected.

Property Documentation

DbEntity^ X3g::Plugin::Articles::ArticleInstance::MainEntity
get

The main entity id of this instance.

PropertyProvider^ X3g::Plugin::Articles::ArticleInstance::Properties
get

Provides properties for the currently selected entity.

DbEntity^ X3g::Plugin::Articles::ArticleInstance::SelectedEntity
get

The currently selected entity of this instance.

bool X3g::Plugin::Articles::ArticleInstance::Valid
get

Returns true if this instance is still valid.

An instance will be invalid after it was closed. At any given time there can be only one valid instance.

See Also
ArticleInstance::Close

Event Documentation

System:: EventHandler^ X3g::Plugin::Articles::ArticleInstance::AnyInstanceClosed
staticaddremoveraise

Fired when an instance has been closed.

There is no valid instance at this point and no pending geometry updates.

As this event is static you should consider to add a singleton event handler or to implement a weak event pattern.

System:: EventHandler^ X3g::Plugin::Articles::ArticleInstance::AnyInstanceClosing
staticaddremoveraise

Fired when current instance is about to be closed.

Current instance is still valid at this point and there may be pending geometry updates.

As this event is static you should consider to add a singleton event handler or to implement a weak event pattern.

System:: EventHandler^ X3g::Plugin::Articles::ArticleInstance::AnyInstanceOpened
staticaddremoveraise

Fired when an article has been instantiated.

As this event is static you should consider to add a singleton event handler or to implement a weak event pattern.