rpti::item
Interact with report items.
- Supported Property Names
-name-value-parent-type (read only)-caption-config-itemlist-itemproperties (readonly)-istemplate-clientdata-icon-expand-execute-export-enable-visible-layoutname (presentation only)
.
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".
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?"
rpti::item::exceldocument
Interact with items of type exceldocument.
- Supported Property Names
-name-value-parent-type (read only)-file-sheet-caption-caption_location
rpti::item::exceldocument create
Creates an item of type "exceldocument".
- Syntax
rpti::item::exceldocument 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::exceldocument create -name "My External Excel Document Item"
rpti::item::exceldocument delete
Deletes the item with the specified ID.
- Syntax
rpti::item::exceldocument 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::exceldocument delete -id $id
rpti::item::exceldocument get
Queries the value of one property.
- Syntax
rpti::item::exceldocument 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::exceldocument get -id $id -property parent
rpti::item::exceldocument getcell
Queries the value of one property from table cell.
- Syntax
rpti::item::exceldocument getcell
- -id
- Mandatory value: Item ID. The item ID which is returned by the corresponding "create" API.
- -row
- Value: Row ID. The ID of the row you want to set a particular header text.
- -column
- Value: Column ID. The ID of the column you want to set a particular header text.
- -property
- Mandatory value: Property name. 'value' or 'href'.
- Returns
- The value of the specified property or .tcl-error in case of error.
- Example
rpti::item::exceldocument getcell -id $id -row 0 -column 0 -property value
rpti::item::exceldocument getpropertyid
Queries ID of property.
- Syntax
rpti::item::exceldocument getpropertyid
- Parameters
-
- -id
- Value: Item ID.
- -key
- Value: Property key.
rpti::item::exceldocument getpropertykeylist
Queries list of properties
- Syntax
rpti::item::exceldocument getpropertykeylist
- Parameters
-
- -id
- Value: Item ID.
- Returns
- List of property keys for a particular item ID.
rpti::item::exceldocument 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::exceldocument 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::exceldocument set -id $id -name "My External Excel Document" -file "c:/temp/mydoc.xlsx"
rpti::item::exceldocument setcell
Sets one or multiple parameters to table cell.
- Syntax
rpti::item::exceldocument setcell
- Parameters
-
- -id
- Mandatory value: Item ID. The item ID which is returned by the corresponding "create" API.
- -row
- Mandatory value: Row ID. Row ID is an integer starting from 0.
- -column
- Mandatory value: Column ID. Column ID is an integer starting from 0.
- -value
- Value: The value you want to set on the cell.
- -href
- Value: Object ID to hyperlink.
- Returns
- 1 for OK, .tcl-error in case of error.
- Example
rpti::item::exceldocument setcell -id $id -row 0 -column 0 -value "Hello" -href $refobjid
rpti::item::externalobject
Interact with items of type externalobject.
- Supported property names
-name-file-parent
rpti::item::externalobject create
Creates an item of type "externalobject".
- Syntax
rpti::item::externalobject 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::externalobject create -name "My Word Document" -file "example.h3d"
rpti::item::externalobject delete
Deletes the item with the specified ID.
- Syntax
rpti::item::externalobject 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::externalobject delete -id $id
rpti::item::externalobject get
Queries the value of one property.
- Syntax
rpti::item::externalobject 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::externalobject get -id $id -property parent
rpti::item::externalobject getpropertyid
Queries ID of property.
- Syntax
rpti::item::externalobject getpropertyid
- Parameters
-
- -id
- Value: Item ID.
- -key
- Value: Property key.
rpti::item::externalobject getpropertykeylist
Queries list of properties.
- Syntax
rpti::item::externalobject getpropertykeylist
- Parameters
-
- -id
- Value: Item ID.
- Returns
- List of property keys for a particular item ID.
rpti::item::externalobject 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::externalobject 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::externalobject set -id $id -name "My External Object" -file "c:/temp/example.h3d"
rpti::item::image
Interact with items of type image.
- Supported Property Names
-name-value-parent-type (read only)-config-hwpage-hwwindow
rpti::item::image create
Creates an item of type "image".
- Syntax
rpti::item::image 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::image create -name "My Image Item"
rpti::item::image delete
Deletes the item with the specified ID.
- Syntax
rpti::item::image 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::image delete -id $id
rpti::item::image get
Queries the value of one property.
- Syntax
rpti::item::image 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::image get -id $id -property parent
rpti::item::image getpropertyid
Queries ID of property.
- Syntax
rpti::item::image getpropertyid
- Parameters
-
- -id
- Value: Item ID.
- -key
- Value: Property key.
rpti::item::image getpropertykeylist
Queries list of properties.
- Syntax
rpti::item::image getpropertykeylist
- Parameters
-
- -id
- Value: Item ID. The item ID which is returned by the corresponding "create" API.
- Returns
- List of property keys for a particular item ID.
rpti::item::image 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::image 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::image set -id $id -name "My Image Item" -value "Good monring, how are you today?"
rpti::item::property
Interact with items of type property.
- Supported Property Names
-name-value-type (create only)-command-setcommand-validatecommand-visible-enabled
- Parameters
-
- -id
- Value: Item ID. Not used.
rpti::item::property create
Creates an item of type "property".
- Syntax
rpti::item::property create
- Parameters
-
- -id
- Mandatory value: Parent item ID of type text,image,table,module etc, \paren
- -key
- Mandatory value: Unique key/name for the property.
- -name
- Value: "Display name of the property, if not specified key is used as display name".
- -type
- (defaults to str): Type of property.
- 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::property create -id $parentid -key "MyKey" -name "My Property" -value "My Value" -type "str"
rpti::item::property delete
Deletes the item with the specified ID.
- Syntax
rpti::item::property delete
- Parameters
-
- -id
- Mandatory value: Parent item ID of type text,image,table,module, and so on.
- -name
- Value: "Display name of the property, if not specified key is used as display name".
- Returns
- 1 for OK, .tcl-error in case of error.
- Example
rpti::item::property delete -id $id
rpti::item::property get
Queries the value of one property.
- Syntax
rpti::item::property 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::property get -id $id -property parent
rpti::item::property set
Sets name and value of specific property.
- Syntax
rpti::item::property 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::property set -id $id -setcommand "::setCommand" -command "::cmdcallback"
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 -> name of the layout-index-> slideindex starts from 1
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?"
rpti::item::table
Interact with items of type table.
- Supported Property Names
-name-value-parent-type (read only)-numberofrows-numberofcolumns-showcolumnheader-showrowheader
rpti::item::table create
Creates an item of type "table".
- Syntax
rpti::item::table 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::table create -name "My Table Item"
rpti::item::table delete
Deletes the item with the specified ID.
- Syntax
rpti::item::table 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::table delete -id $id
rpti::item::table get
Queries the value of one property.
- Syntax
rpti::item::table 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::table get -id $id -property parent
rpti::item::table getcell
Queries the value on a cell identified by row and column ID. Row and column IDs start with 0.
- Syntax
rpti::item::table getcell
- Parameters
-
- -id
- Mandatory value: Item ID. The item ID which is returned by the corresponding "create" API.
- -row
- Mandatory value: Row ID. The ID of the row.
- -column
- Mandatory value: Column ID. The ID of the column.
- -property
- Mandatory value: 'value', 'href', 'color', 'textcolor', 'fontname', 'fontstyle', 'horizontal_alignment' and 'vertical_alignment'
- Returns
- 1 for OK, .tcl-error in case of error.
- Example
ardi::item::text set -id $id -name "My Text Item" -value "Good monring, how are you today?"
rpti::item::table getheader
Queries the header text on a row or on a column. Row and column IDs start with 1. Specify either row or column ID to query the current value.
- Syntax
rpti::item::table getheader
- Parameters
-
- -id
- Mandatory value: Item ID. The item ID which is returned by the corresponding "create" API.
- -row
- Mandatory value: Row ID. The ID of the row you want to query the header text.
- -column
- Mandatory value: Column ID. The ID of the column you want to query the header text.
- Returns
- The header text, .tcl-error in case of error.
- Example
rpti::item::table getheader -id $id -column 1
rpti::item::table getpropertyid
Queries ID of property.
- Syntax
rpti::item::table getpropertyid
- Parameters
-
- -id
- Mandatory value: Item ID.
- -key
- Value: Property key.
rpti::item::table getpropertykeylist
Queries list of properties
- Syntax
rpti::item::table getpropertykeylist
- Parameters
-
- -id
- Mandatory value: Item ID.
- Returns
- List of property keys for a particular item ID.
rpti::item::table 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::table 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::table set -id $id -name "My Table Item" -value "Good monring, how are you today?"
rpti::item::table setcell
Sets the value on a cell identified by row and column ID. Row and column IDs start with 0.
- Syntax
rpti::item::table setcell
- Parameters
-
- -id
- Mandatory value: Item ID. The item ID which is returned by the corresponding "create" API.
- -row
- Mandatory value: Row ID. The item ID of the row.
- -column
- Mandatory value: Column ID. The item ID of the column.
- -value
- Value: The value you want to set on the cell.
- -href
- Value: Object ID to set cross-reference to.
- -color
- Value: Comma separated RGB color values. Color is applied to cell background, for example, for red color, specify "-color 255,0,0".
- -textcolor
- Value: Comma separated RGB color values. Valid values: comma separated RGB color value. For example, for green color, specify "-textcolor 0,255,0"
- -fontname
- Value: Font name. Note: Value is case-sensitive.
- -fontsize
- Value: Font size - a non-zero integer value.
- -fontstyle
- Value: Comma separated value of styles. Valid styles are 'bold', 'italic' or 'underline'. You can club styles like - "-fontstyle bold,italic"
- -fontstyle
- Value: Comma separated value of styles. Valid styles are 'bold', 'italic' or 'underline'. You can club styles like - "-fontstyle bold,italic"
- -horizontal_alignment
- Value: Alignment value. Valid values are 'left', 'center' or 'right'.
- -vertical_alignment
- Value: Alignment value. Valid values are 'top', 'middle' or 'bottom'.
- Returns
- 1 for OK, .tcl-error in case of error.
- Example
rpti::item::table setcell -id $id -column 1 -value "My Header Text on column 1"
rpti::item::table setheader
Sets the header text on a row or on a column. Row and column IDs start with 0. Specify either row or column ID to set the header text to desired value.
- Syntax
rpti::item::table setheader
- Parameters
-
- -id
- Mandatory value: Item ID. The item ID which is returned by the corresponding "create" API.
- -row
- Mandatory value: Row ID. The ID of the row you want to set a particular header text.
- -column
- Mandatory value: Column ID. The ID of the column you want to set a particular header text.
- -value
- Value: The text you want to set as header of the specified row or column ID.
- Returns
- 1 for OK, .tcl-error in case of error.
- Example
rpti::item::table setheader -id $id -column 1 -value "My Header Text on column 1"
rpti::item::tableofreference
Interact with items of type tableofreference.
- upported property names
-name -value -parent
rpti::item::tableofreference create
Creates an item of type "tableofreference".
- Syntax
rpti::item::tableofreference create
- Parameters
-
- For
- Value: A full list of standard property names see Supported property name above.
- Returns
- The ID of the item type table or .tcl-error in case an error occurred during creation.
- Example
rpti::item::module create -name "My Module" -value {{A B C D} {2 2}} -parent $rootid value format : {{list data} {$numrows $numcols}}. data should match numrows X numcols
rpti::item::tableofreference delete
Deletes the item with the specified ID.
- Syntax
rpti::item::tableofreference 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::tableofreference delete -id $id
rpti::item::tableofreference get
Queries the value of one property.
- Syntax
rpti::item::tableofreference 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::tableofreference get -id $id -property parent
rpti::item::tableofreference getpropertyid
Queries ID of property.
- Syntax
rpti::item::tableofreference getpropertyid
- Parameters
-
- -id
- Value: Item ID.
- -key
- Value: Property key.
- Returns
- 1 for OK, .tcl-error in case of error.
- Example
ardi::item::text set -id $id -name "My Text Item" -value "Good monring, how are you today?"
rpti::item::tableofreference getpropertykeylist
Queries list of properties
- Syntax
rpti::item::tableofreference getpropertykeylist
- Parameters
-
- -id
- Item: Item ID.
- Returns
- List of property keys for a particular item ID.
rpti::item::tableofreference 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::tableofreference 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::tableofreference set -id $id -name "My Table of References" -value {{X Y 0.1 0.2} {2 2}} -parent $parentid
rpti::item::text
Interact with items of type text.
- Supported Property Names
-name -value -parent -type (read only)
rpti::item::text create
Creates an item of type "text".
- Syntax
rpti::item::text 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::text create -name "My Text Item"
rpti::item::text delete
Deletes the item with the specified ID.
- Syntax
rpti::item::text 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::text delete -id $id
rpti::item::text get
Queries the value of one property.
- Syntax
rpti::item::text get
report::item 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
- The value of the specified property or .tcl-error in case of error.
- Example
rpti::item::text get -id $id -property parent
rpti::item::text getcrossref
Queries the cross reference within text item.
- Syntax
rpti::item::text getcrossref
- Parameters
-
- -id
- Mandatory value: Item ID. The item ID which is returned by the corresponding "create" API.
rpti::item::text getpropertyid
Queries ID of property.
- Syntax
rpti::item::text getpropertyid
- Parameters
-
- -id
- Value: Item ID.
- -key
- Value: Property key.
rpti::item::text getpropertykeylist
Queries list of properties
- Syntax
rpti::item::text getpropertykeylist
- Parameters
-
- -id
- Mandatory value: Item ID.
- Returns
- List of property keys for a particular item ID.
rpti::item::text 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::text 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::text set -id $id -name "My Text Item" -value "Good monring, how are you today?"
rpti::item::text setcrossref
Sets the cross reference within text item.
- Syntax
rpti::item::text setcrossref
- Parameters
-
- -id
- Mandatory value: Item ID. The item ID which is returned by the corresponding "create" API.
- -value
- Mandatory value: {location refobjid}. location: {startposition endposition}. Position is <lineno>.<charindex>. endposition is not included inside the reference link. Refer to usage section for reference.
- Example
set textid [rpti::item::text create -name "Crossref-demo" -value "Text Box Link: Href"] rpti::item::text setcrossref -id $textid -value {{1.15 1.19} $tbox1id}"
rpti::item::textdocument
Interact with items of type textdocument.
- Supported Property Names
-name -file -parent
rpti::item::textdocument create
Creates an item of type "textdocument".
- Syntax
rpti::item::textdocument 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::textdocument create -name "My Text File" -file "example.txt"
rpti::item::textdocument delete
Deletes the item with the specified ID.
- Syntax
rpti::item::textdocument 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::textdocument delete -id $id
rpti::item::textdocument get
Queries the value of one property.
- Syntax
rpti::item::textdocument 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::textdocument get -id $id -property parent
rpti::item::textdocument getpropertyid
Queries ID of property.
- Syntax
rpti::item::textdocument getpropertyid
- Parameters
-
- -id
- Value: Item ID.
- -key
- Value: Property key.
rpti::item::textdocument getpropertykeylist
Queries list of properties
- Syntax
rpti::item::textdocument getpropertykeylist
- Parameters
-
- -id
- Value: Item ID.
- Returns
- List of property keys for a particular item ID.
rpti::item::textdocument 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::textdocument 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::textdocument set -id $id -name "My External Excel Document" -file "c:/temp/textdocument.txt"
rpti::item::worddocument
Interact with items of type worddocument.
- Supported Property Names
-name -file -parent
rpti::item::worddocument create
Creates an item of type "worddocument".
- Syntax
rpti::item::worddocument 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::worddocument create -name "My Word Document" -file "example.docx"
rpti::item::worddocument delete
Deletes the item with the specified ID.
- Syntax
rpti::item::worddocument 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::worddocument delete -id $id
rpti::item::worddocument get
Queries the value of one property.
- Syntax
rpti::item::worddocument 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::worddocument get -id $id -property parent
rpti::item::worddocument getpropertyid
Queries ID of property.
- Syntax
rpti::item::worddocument getpropertyid
- Parameters
-
- -id
- Value: Item ID.
- -key
- Value: Property key.
rpti::item::worddocument getpropertykeylist
Queries list of properties
- Syntax
rpti::item::worddocument getpropertykeylist
- Parameters
-
- -id
- Value: Item ID.
- Returns
- List of property keys for a particular item id.
rpti::item::worddocument 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::worddocument 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::worddocument set -id $id -name "My External Word Document" -file "c:/temp/example.docx"
rpti::item apply
For better performance data created, manipulated or deleted go into a cache.
- Syntax
rpti::item apply
- Parameters
-
- -name
- Value: Layout name to use in case of presentation.
- -itemlist
- Value: List of items ID to apply.
- -parent
- Value: parent of the cached items. if not specified root item will act as a parent. This API processes the cached data, clears the cache and redraws the GUI if needed.
- Returns
- 1 for OK, .tcl-error in case of error.
rpti::item clone
Clone an Item.
- Syntax
rpti::item clone
- Parameters
-
- -id
- Value: Item ID.
- Returns
- New item ID.
rpti::item delete
Deletes the item with the specified ID.
- Syntax
rpti::item delete
- Parameters
-
- -id
- Value: Item ID.
- Returns
- 1 for OK, .tcl-error in case of error.
rpti::item get
Queries the value of one property or role or attribute.
- Syntax
rpti::item 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. Use
rpti::item getpropertykeylist
for list of dynamic properties.
- Returns
- The value of the specified property/role/attribute or .tcl-error in case of error.
- Example
rpti::item get -id $id -property parent usage: rpti::item get -id $id -role rolename usage: rpti::item get -id $id -attribute attributename
rpti::item getattribute
Get item attribute.
- Syntax
rpti::item getattribute
- Parameters
-
- -id
- Value: Item ID.
- -name
- Value: Attribute name.
rpti::item getinterface
Get Item Interface.
- Syntax
rpti::item getinterface
- Parameters
-
- -name
- Value: Report session name.
rpti::item getpropertyid
Queries ID of property.
- Syntax
rpti::item getpropertyid
- Parameters
-
- -id
- Value: Item ID.
- -key
- Value: Property key.
rpti::item getpropertykeylist
Queries list of properties.
- Syntax
rpti::item getpropertykeylist
- Parameters
-
- -id
- Value: Item ID.
- Returns
- List of property keys for a particular item ID.
rpti::item getrole
Get item role.
- Syntax
rpti::item getrole
- Parameters
-
- -id
- Mandatory value: Item ID.
- -name
- Value: Role name.
- Returns
- The role value.
rpti::item getroot
Queries the ID of the report root item.
- Syntax
rpti::item getroot
- Parameters
-
- -id
- Value: Item ID.
- Returns
- The ID of the report root item.
rpti::item getselection
Queries current selected item.
- Syntax
rpti::item getselection
- Returns
- The selected item ID.
rpti::item getSlideLayouts
Queries Slide Layouts. Existing slides in a presentation is treated as slide layouts.
- Syntax
rpti::item getSlideLayouts
- Returns
- The list of layout IDs.
rpti::item gettype
Queries the type of the item with the specified ID.
- Syntax
rpti::item gettype
- Parameters
-
- -id
- Value: Item ID.
- Returns
- The type of the item.
rpti::item getypelist
Queries available types of items.
- Syntax
rpti::item gettypelist
- Returns
- A list of item types.
rpti::item hasattribute
Check if an item attribute exists.
- Syntax
rpti::item hasattribute
- Parameters
-
- -id
- Value: Item ID.
- -name
- Value: Attribute name.
- Returns
- 1 if role exists, 0 if role does not exist.
rpti::item hasProperty
Check if the item has property with specified key.
- Syntax
rpti::item hasProperty
- Parameters
-
- -id
- Value: Item ID.
- -key
- Value: Property key.
- Returns
- 1 if valid, 0 if invalid.
rpti::item hasrole
Check if an item role exists.
- Syntax
rpti::item hasrole
- Parameters
-
- -id
- Value: Item ID.
- -name
- Value: Role name.
- Returns
- 1 if role exists, 0 if role does not exist.
rpti::item insert
Insert an item to a parent.
- Syntax
rpti::item insert
- Parameters
-
- -id
- Value: Item ID. Item ID to insert.
\parent -parent parentitemid: parent item id
- -index
- Value: Index in parent.
- Returns
- 1 if success, error message if failed.
rpti::item isleaf
Check if the item is a leaf.
- Syntax
rpti::item isleaf
- Parameters
-
- -id
- Value: Item ID.
- Returns
- 1 if valid, 0 if invalid.
rpti::item isvalid
Check if the item with the specified ID is valid.
- Syntax
rpti::item isvalid
- Parameters
-
- -id
- Value: Item ID.
- Returns
- 1 if valid, 0 if invalid.
rpti::item loadproperty
Load items properties defined in configuration xml.
- Syntax
rpti::item loadproperty
- Parameters
-
- -id
- Value: Item ID.
- Returns
- 1 if success, error message if failed.
rpti::item redraw
Notifies all registered views to redraw itself.
- Syntax
rpti::item redraw
rpti::item remove
Remove an item from parent.
- Syntax
rpti::item remove
- Parameters
-
- -id
- Value: Item ID. Item ID to remove.
- Returns
- 1 if success, error message if failed.
rpti::item removerole
Remove item role if exists.
- Syntax
rpti::item removerole
- Parameters
-
- -id
- Value: Item ID.
- -name
- Value: Role name
rpti::item reparent
Reparents an object that already has a parent.
- Syntax
rpti::item reparent
- Parameters
-
- -id
- Value: Item ID. The item ID to reparent.
\parent -newparent parentitemid:
New parent item ID.
- -index
- Value: Index in new parent
- Returns
- 1 if success, error message if failed.
rpti::item set
Sets one or multiple parameters to specified values.
- Syntax
rpti::item 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. Use
rpti::item getpropertykeylist
for list of dynamic properties.
- Returns
- 1 for OK, .tcl-error in case of error.
- Example
ardi::item::text set -id $id -name "My Text Item" -value "Good monring, how are you today?"
rpti::item setattribute
Sets/update item attribute.
- Syntax
rpti::item setattribute
- Parameters
-
- -id
- Value: Item ID.
- -name
- Value: Attribute Name which is usually a string.
- -value
- Value: Attribute value.
- Returns
- 1 if success, error message if failed.
rpti::item setrole
Set/update item role
- Syntax
rpti::item setrole
- Parameters
-
- -id
- Value: Item ID.
- -name
- Value: Role name which is usually a string.
- -value
- Value: Role value.
- Returns
- 1 if success, error message if failed.
rpti::item setselection
Queries current selected item set using rpti::item setselection
.
- Syntax
rpti::item setselection
- Returns
- Selected item id.
rpti::item validate
Evaluates registered validate callback.
- Syntax
rpti::item validate
- Parameters
-
- -id
- Value: Item ID. Returns -1 if errors, 0 if warnings, and 1 if passed.