rpti::item::table

Interact with items of type table.

Supported Property Names
To set table properties, use the following:
name
Name of the table.
Value
String
label
Caption
Value
String
table_source
Source
Value
Data, External CSV/XLSX, TableView Window, HyperMesh Table and Matrix Browser Table
table_data
Data
Value
<internal table data>
position
Location of Caption
Value
Below Table and Above Table
split_table
Auto Split Table
Value
0 or 1
split_table_type
Split by columns or rows
Value
Columns or Rows
Auto split table by row or column.
split_rows
Maximum Rows
Value
Integer
split_cols
Maximum Columns
Value
Integer

rpti::item::table create

Creates an item of type "table".

Syntax
rpti::item::table create
Parameters
For
A full list of standard property names see Supported property name above.
-color
Set fill color for all the cells in the table.
Example
::ardi::item::table set -id $tableid -color "255,255,0"::ardi::item::table set -id $tableid -color "#c36d5b"
-textcolor
Set text color for all the cells in the table.
Example
::ardi::item::table set -id $tableid -textcolor "#c8eed4"
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
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
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
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
Set font name for all the cells in the table.
Example
::ardi::item::table set -id $tableid -fontname "Arial"
-fontsize
Set font size for all the cells in the table.
Example
::ardi::item::table set -id $tableid -fontsize "10" , assign only integers
-fontstyle
Set font style for all the cells in the table.
Example
::ardi::item::table set -id $tableid -fontstyle "bold|italic|underline"
-horizontal_alignment
Set horizontal text alignment for all the cells in the table.
Example
::ardi::item::table set -id $tableid -horizontal_alignment "left" (left,right,middle)
-vertical_alignment
Set vertical text alignment for all the cells in the table.
Example
::ardi::item::table set -id $tableid -horizontal_alignment "top" (top,bottom,middle)
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"