<property>

Class defining a property of any user object.

Remarks

None.

Examples

None.

Table 76: XML Tag Listing

Tag

<Attributes>

No details provided. (inherited from PropertyBase)

Tag

<Callbacks>

No details provided. (inherited from PropertyBase)

Callback

<GetValue>

Callback that is invoked when the property value is acquired. (inherited from PropertyBase)

Tag

<help>

No details provided. (inherited from PropertyBase)

Callback

<IsValid>

Callback that is invoked to determine whether the property is valid. (inherited from PropertyBase)

Callback

<IsVisible>

Callback that is invoked to determine whether the property is visible. (inherited from PropertyBase)

Callback

<OnActivate>

Callback that is invoked when the property is activated. (inherited from PropertyBase)

Callback

<OnAdd>

Callback that is invoked when the property is added. (inherited from PropertyBase)

Callback

<OnAfterGeometryUpdate>

Callback that is invoked after the geometry has been updated. (inherited from PropertyBase)

Callback

<OnApply>

Callback that is invoked when the property apply button is clicked. (inherited from PropertyBase)

Callback

<OnBodySuppressStateChange>

Callback that is invoked when the body suppress state change. (inherited from PropertyBase)

Callback

<OnButtonClick>

Callback that is invoked when click on a property's button (inherited from PropertyBase)

Callback

<OnCancel>

Callback that is invoked when the property cancel button is clicked. (inherited from PropertyBase)

Callback

<OnDuplicate>

Callback that is invoked when the property is duplicated. (inherited from PropertyBase)

Callback

<OnHide>

Callback that is invoked when the property is hidden. (inherited from PropertyBase)

Callback

<OnInit>

Callback that is invoked when the property is initialized. (inherited from PropertyBase)

Callback

<OnJournalExecuting>

Callback that is invoked before executing an action written in the journal. (inherited from PropertyBase)

Callback

<OnJournalRecording>

Callback that is invoked before writting the journal for an action. (inherited from PropertyBase)

Callback

<OnMigrate>

Callback that is invoked when the property version has been changed. (inherited from PropertyBase)

Callback

<OnRemove>

Callback that is invoked when the property is removed. (inherited from PropertyBase)

Callback

<OnShow>

Callback that is invoked when the property is shown. (inherited from PropertyBase)

Callback

<OnValidate>

Callback that is invoked when the property is validated. (inherited from PropertyBase)

Callback

<SetValue>

Callback that is invoked when the property value is set. (inherited from PropertyBase)

Callback

<String2Value>

Callback that is invoked to convert a string to the property value. (inherited from PropertyBase)

Callback

<Value2String>

Callback that is invoked to convert the value stored by the property into a string. (inherited from PropertyBase)

Attribute

caption=

Caption of the property. (inherited from PropertyBase)

Attribute

class=

Class name of the property's controller. (inherited from PropertyBase)

Attribute

control=

Control type of the object.

Attribute

default=

Default value of the property. (inherited from PropertyBase)

Attribute

elementtype=

Property list element type (workflow). (inherited from PropertyBase)

Attribute

isparameter=

Indicates whether the property is a parameter. (inherited from PropertyBase)

Attribute

keytype=

Property dictionary key type (workflow). (inherited from PropertyBase)

Attribute

localize=

Indicates whether the caption and value string need to be localized by the application. (inherited from PropertyBase)

Attribute

name=

Name of the property. (inherited from PropertyBase)

Attribute

needupdate=

Indicates whether the context must be refreshed when the property value changes. (inherited from PropertyBase)

Attribute

parameterizable=

Specifies the property parameterization (workflow). Indicates whether the property should be a candidate for parameterization (in the schematic property view, a check-box will appear). (inherited from PropertyBase)

Attribute

persistent=

Specifies the property persistence (workflow). Indicates whether the property data should be saved within the project. (inherited from PropertyBase)

Attribute

readonly=

Indicates whether the property is read-only. (inherited from PropertyBase)

Attribute

unit=

Unit type of the property (for 'control' equals to 'float' only). (inherited from PropertyBase)

Attribute

valuetype=

Property dictionary value type (workflow). (inherited from PropertyBase)

Attribute

visible=

Indicates whether the property is visible. (inherited from PropertyBase)

Attribute

visibleon=

Specifies property visibility. With a PropertyGroup parent of control type "select", indicates the select values for this property to be visible (separate with '|'). (inherited from PropertyBase)