rpti::item::property

Interact with items of type property.

Supported Property Names
-name -value -type(create only) -command -setcommand -validatecommand -visible -enabled
All properties available can be passed via the "create" API. Specific property can be set using "set" API, for example, command, setcommand, getcommand, validatecommand,help use getattributelist for complete list of attributes. Some of the attributes such as -command-getlistcommand are type specific. Queries list of available attributes.
Parameters
-id
Value: Item ID. Not used.

rpti::item::property create

Creates an item of type "property".

Syntax
rpti::item::property create
Parameters
-id
Mandatory value: Parent item ID of type text,image,table,module etc, \paren
-key
Mandatory value: Unique key/name for the property.
-name
Value: "Display name of the property, if not specified key is used as display name".
-type
(defaults to str): Type of property.
For
Value: A full list of standard property names see Supported property name above.
Returns
The ID of the item or .tcl-error in case an error occurred during creation.
Example
rpti::item::property create -id $parentid -key "MyKey" -name "My Property" -value "My Value" -type "str"

rpti::item::property delete

Deletes the item with the specified ID.

Syntax
rpti::item::property delete
Parameters
-id
Mandatory value: Parent item ID of type text,image,table,module, and so on.
-name
Value: "Display name of the property, if not specified key is used as display name".
Returns
1 for OK, .tcl-error in case of error.
Example
rpti::item::property delete -id $id

rpti::item::property get

Queries the value of one property.

Syntax
rpti::item::property get
Parameters
-id
Mandatory value: Item ID. The item ID which is returned by the corresponding "create" API.
For
Value: A full list of standard property names see Supported property name above.
Returns
The value of the specified property or .tcl-error in case of error.
Example
rpti::item::property get -id $id -property parent

rpti::item::property set

Sets name and value of specific property.

Syntax
rpti::item::property set
Parameters
-id
Mandatory value: Item ID. The item ID which is returned by the corresponding "create" API.
For
Value: A full list of standard property names see Supported property name above.
Returns
1 for OK, .tcl-error in case of error.
Example
rpti::item::property set -id $id -setcommand "::setCommand" -command "::cmdcallback"