rpti::item::break
Interact with items of type break.
- Supported Property Names
-name -parent -type(read only)-orientation
.
rpti::item::break create
Creates an item of type "break".
- Syntax
rpti::item::break create
- Parameters
-
- For
- Value: A full list of standard property names see Supported Property Names above.
- Returns
- The ID of the item or .tcl -error in case an error occurred during creation.
- Example
rpti::item::break create -name "My Page Break"
rpti::item::break delete
Deletes the item with the specified ID.
- Syntax
rpti::item::break delete
- Parameters
-
- -id
- Mandatory value: Item ID. The item ID which is returned by the corresponding "create" API.
- Returns
- 1 for OK, .tcl-error in case of error.
- Example
rpti::item::break delete -id $id
rpti::item::break get
Queries the value of one property.
- Syntax
rpti::item::break get
- Parameters
-
- -id
- Mandatory value: Item ID. The item ID which is returned by the corresponding "create" API.
- For
- Value: A full list of property names see Supported property name above.
- Returns
- The value of the specified property or .tcl-error in case of error.
- Example
rpti::item::break get -id $id -property parent
rpti::item::break getpropertyid
Queries ID of property.
- Syntax
rpti::item::break getpropertyid
- Parameters
-
- -id
- Value: Item ID.
- -key
- Value: Property key.
rpti::item::break getpropertykeylist
Queries list of properties
- Syntax
rpti::item::break getpropertykeylist
- Parameters
-
- -id
- Value: Item ID.
- Returns
- List of property keys for a particular item ID.
rpti::item::break set
Sets one or multiple parameters to specified values. The type of the item is assigned upon creation and cannot be changed after.
- Syntax
rpti::item::break set
- Parameters
-
- -id
- Mandatory value: Item ID. The item ID which is returned by the corresponding "create" API.
- For
- Value: A full list of property names see Supported property name above.
- Returns
- 1 for OK, .tcl-error in case of error, that is, rpti::item::break set-id $id -name "My External Excel Document" -file "c:/temp/mydoc.xlsx".