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

OFML article instance. More...

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

Public Member Functions

bool SetSelectedObject (OfmlObject^ pObject)
 Changes the selected ofml object of this instance. More...
 
OfmlObjectGetObject (String^ pObjectName)
 Returns the ofml object with the given name. More...
 
void SetObjectStateModified ()
 Sets Modified flag which will cause an update of database entities at the latest when instance is closed. More...
 
- Public Member Functions inherited from X3g::Plugin::Articles::ArticleInstance
void Close ()
 Closes the instance and applies all changes. More...
 

Properties

OfmlObject^  RootObject [get]
 The root ofml object of this instance. More...
 
OfmlObject^  SelectedObject [get]
 The currently selected ofml object of this instance. More...
 
- Properties inherited from X3g::Plugin::Articles::ArticleInstance
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...
 

Additional Inherited Members

- Events inherited from X3g::Plugin::Articles::ArticleInstance
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

OFML article instance.

Member Function Documentation

OfmlObject X3g::Plugin::Articles::OfmlArticleInstance::GetObject ( String pObjectName)

Returns the ofml object with the given name.

Exceptions
System::ExceptionAn exception will be thrown if this instance is no longer valid.
void X3g::Plugin::Articles::OfmlArticleInstance::SetObjectStateModified ( )

Sets Modified flag which will cause an update of database entities at the latest when instance is closed.

Clients should call this function if they modified ofml objects associated with this instance through ofml method calls.

Exceptions
System::ExceptionAn exception will be thrown if this instance is no longer valid.
See Also
OfmlObject::CallMethod
bool X3g::Plugin::Articles::OfmlArticleInstance::SetSelectedObject ( OfmlObject pObject)

Changes the selected ofml object of this instance.

Exceptions
System::ExceptionAn exception will be thrown if this instance is no longer valid.

Property Documentation

OfmlObject^ X3g::Plugin::Articles::OfmlArticleInstance::RootObject
get

The root ofml object of this instance.

OfmlObject^ X3g::Plugin::Articles::OfmlArticleInstance::SelectedObject
get

The currently selected ofml object of this instance.

IArticleInstance::PropertyProvider and IArticleInstance::getArticleInformation() operate on the selected object.