rpti::item::slide

Interact with items of type slide. This item type is valid only for presentation reports.

Supported Property Names
-name -value -parent -type(read only) -layoutname or -index -layoutname
Note:
  • -layoutname: name of the layout.
  • The slideindex starts from 1
All properties available can be passed via the "create" API or modified on an existing item via the "set" API.

rpti::item::slide create

Creates an item of type "slide".

Syntax
rpti::item::slide create
Parameters
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::slide create -name "My Slide Item"

rpti::item::slide delete

Deletes the item with the specified ID.

Syntax
rpti::item::slide delete
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. Use rpti::item getpropertykeylist for list of dynamic properties.
Returns
1 for OK, .tcl-error in case of error.
Example
rpti::item::slide delete -id $id

rpti::item::slide get

Queries the value of one property.

Syntax
rpti::item::slide 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::slide get -id $id -property parent

rpti::item::slide getpropertyid

Queries ID of property.

Syntax
rpti::item::slide getpropertyid
Parameters
-id
Mandatory value: Item ID. The item ID which is returned by the corresponding "create" API.
-key
Value: Property key.

rpti::item::slide getpropertykeylist

Queries list of properties.

Syntax
rpti::item::slide getpropertykeylist
Parameters
-id
Mandatory value: Item ID. The item ID which is returned by the corresponding "create" API.

rpti::item::slide 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::slide 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::slide set -id $id -name "My Slide Item" -value "Good monring, how are you today?"