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

Property. More...

Inherited by X3g::Plugin::PropertyImpl.

Public Member Functions

bool SetValue (PropertyValue^ pValue, bool pUndoable)
 Assigns a new value to the property. More...
 
void Hide ()
 Hide this property at property editor. More...
 
void Unhide ()
 Unhide this property at property editor if hidden by Hide. More...
 

Properties

String^  Key [get]
 The key of the property. More...
 
PropertyType Type [get]
 The type of the property. More...
 
String^  Name [get]
 The name of the property. More...
 
String^  Description [get]
 The description of the property. More...
 
ReadOnlyCollection
< PropertyValue^ >^ 
ValueSet [get]
 Returns an optional list of valid values for this property. More...
 
PropertyValue^  Value [get]
 The current value of the property. More...
 
PropertyState State [get]
 The state of the property. More...
 

Detailed Description

Property.

Member Function Documentation

void X3g::Plugin::IProperty::Hide ( )

Hide this property at property editor.

bool X3g::Plugin::IProperty::SetValue ( PropertyValue pValue,
bool  pUndoable 
)

Assigns a new value to the property.

If pUndoable is true, an undo step will be created.

Changing the value of a property may also change the state and the value of other properterties if they depend on each other. Changing the value may even add new properties. Therefore, IPropertyProvider::GetProperties() should be called again to get an up-to-date property list.

void X3g::Plugin::IProperty::Unhide ( )

Unhide this property at property editor if hidden by Hide.

Property Documentation

String^ X3g::Plugin::IProperty::Description
get

The description of the property.

String^ X3g::Plugin::IProperty::Key
get

The key of the property.

String^ X3g::Plugin::IProperty::Name
get

The name of the property.

PropertyState X3g::Plugin::IProperty::State
get

The state of the property.

PropertyType X3g::Plugin::IProperty::Type
get

The type of the property.

PropertyValue^ X3g::Plugin::IProperty::Value
get

The current value of the property.

ReadOnlyCollection< PropertyValue^>^ X3g::Plugin::IProperty::ValueSet
get

Returns an optional list of valid values for this property.