ardi::item::break
Interact with items of type break.
Supported property names are: -name -parent -type (read only) -orientation All properties available can be passed via the "create" API or modified on an existing item via the "set" API.
ardi::item::break::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::break create -name "My Page Break"
ardi::item::break::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::break::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::break get -id $id -property parent
ardi::item::break::getpropertyid args
- Parameters
-
- -id
- value: item ID
- -key
- value: property key
ardi::item::break::getpropertykeylist args
- Parameters
-
- -id
- value: item ID
- Returns
- list of property keys for a particular item ID
ardi::item::break::set args
- Parameters
-
- -id (mandatory)
- value: item ID. The item ID which is returned by the corresponding "create" API.
- Returns
- For a full list of property names, see above.