rpti::item::chapter
Interact with items of type chapter. This item type is valid only for document reports.
- Supported Property Names
-name-value-parent-type (read only)
rpti::item::chapter create
Creates an item of type "chapter".
- Syntax
rpti::item::chapter create
- Parameters
-
- For
- Value: A full list of 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::chapter create -name "My Chapter Item"
rpti::item::chapter delete
Deletes the item with the specified ID.
- Syntax
rpti::item::chapter 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::chapter delete -id $id
rpti::item::chapter get
Queries the value of one property.
- Syntax
rpti::item::chapter 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::chapter get -id $id -property parent
rpti::item::chapter getpropertyid
Queries ID of property.
- Syntax
rpti::item::chapter getpropertyid
- Parameters
-
- -id
- Value: Item ID.
- -key
- Value: Property key
rpti::item::chapter getpropertykeylist
Queries list of properties
- Syntax
rpti::item::chapter getpropertykeylist
- Parameters
-
- -id
- Value: Item ID.
- Returns
- List of property keys for a particular item ID.
rpti::item::chapter 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::chapter 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.
- Example
rpti::item::chapter set -id $id -name "My Chapter Item" -value "Good monring, how are you today?"