ardi::item::text
Interact with items of type text.
Supported property names are: -name -value -parent -type (read only). All properties available can be passed via the "create" API or modified on an existing item via the "set" API.
ardi::item::text create args
- Parameters
- For a full list of property names, see above.
- Returns
- The ID of the item or tcl-error in case an error occurred during creation. i.e ardi::api::item::text create -name "My Text Item"
ardi::item::text delete args
- Parameters
-
- -id (mandatory)
- value: item ID. The item ID which is returned by the corresponding "create" API.
- Returns
- 1 for ok
ardi::item::text get args
- Parameters
-
- -id (mandatory)
- value: item ID. The item ID which is returned by the corresponding "create" API.
- For a full list of property names, see above.
- Returns
- The value of the specified property or tcl-error in case of error usage: ardi::item::text get -id $id -property parent
ardi::item::text getpropertyid args
- Parameters
-
- -id
- value: item ID
- -key
- value: property key
ardi::item::text getpropertykeylist args
- Parameters
-
- -id
- value: item ID
- Returns
- list of property keys for a particular item ID
ardi::item::text set args
- Parameters
-
- -id (mandatory)
- value: item ID. The item ID which is returned by the corresponding "create" API.
- For a full list of property names, see above.
- Returns
- 1 for ok