Property Methods
The following methods control the setting and getting of properties on various object types within Cadcorp SIS Desktop.
Properties fall into two categories: members and user-defined attributes. Members are the internal, system properties of an object (e.g. Item ID and Pen on an item or number of overlays on a window).
User-defined attributes are the properties added programmatically by an application or interactively by the user (e.g. "CostPerSqM#").
Note: Some members can only be queried and not set, e.g. Item ID.
Some members have special meaning (each is returned as a space-separated list):
_properties$
|
- all of the properties of an object (members and attributes). |
_properties_edit$
|
- all of the editable members of an object. |
_members$
|
- all of the members of an object. |
_attributes$
|
- all of the user-defined attributes of an object. |
The following object types can have their properties queried and set:
- SIS_OT_CURITEM
- SIS_OT_DEFITEM
- SIS_OT_DATASET
- SIS_OT_OVERLAY
- SIS_OT_WINDOW
- SIS_OT_NOL
- SIS_OT_FTABLE
- SIS_OT_SCHEMA
- SIS_OT_SCHEMACOLUMN
- SIS_OT_THEME
- SIS_OT_THEMECOMPONENT
- SIS_OT_PRINTER
- SIS_OT_SYSTEM
- SIS_OT_OPTION
DescribeProperty | Sets the description of a property. |
Evaluate | Evaluates an expression. |
EvaluateFlt | Evaluates an expression that has a floating point result. |
EvaluateInt | Evaluates an expression that has an integer result. |
EvaluateStr | Evaluates an expression that has a string result. |
GetFlt | Gets the value of a floating point property. |
GetInt | Gets the value of an integer property. |
GetListItemFlt | Gets the value of a floating point property from an Item in a Named List. |
GetListItemInt | Gets the value of an integer property from an Item in a Named List. |
GetListItemStr | Gets the value of a string property from an Item in a Named List. |
GetProfileStr | Gets the value of a string profile property |
GetProperty | Gets the value of a property. |
GetPropertyDescription | Gets the description of a property. |
GetStr | Gets the value of a string property. |
GetStrW | Gets the Unicode value of a string property. |
RemoveAtt | Removes an attribute from the current open item. |
RemoveListAtt | Removes an attribute from all of the items in a named list. |
RemoveProperty | Removes a property from an object. |
SetFlt | Sets the value of a floating point property. |
SetInt | Sets the value of an integer property. |
SetListFlt | Sets the value of a floating point property on the items in a named list. |
SetListFormula | Sets the value of a property on items in a named list, using the result of a expression. |
SetListInt | Sets the value of an integer property on the items in a named list. |
SetListStr | Sets the value of a string property on the items in a named list. |
SetProfileStr | Sets the value of a string profile property. |
SetProperty | Sets the value of a property. |
SetStr | Sets the value of a string property. |
SetStrW | Sets the Unicode value of a string property. |