ardi::item::table

Interact with items of type table.

Supported property names are: -name -value -parent -type (read only) -numberofrows -numberofcolumns -showcolumnheader -showrowheader. All properties available can be passed via the "create" API or modified on an existing item via the "set" API.

ardi::item::table create args

Creates an item of type "table".
Parameters
For a full list of property names, see above.
Returns
The ID of the item or tcl-error in case an error occurred during creation. i.e ardi::api::item::table create -name "My Table Item"

ardi::item::table delete args

Deletes the item with the specified ID.
Parameters
-id (mandatory)
value: item ID. The item ID which is returned by the corresponding "create" API.
default value: ""
Returns
1 for ok
tcl-error in case of error i.e ardi::api::item::table delete -id $id

ardi::item::table get args

Queries the value of one property.
Parameters
-id (mandatory)
value: item ID. The item ID which is returned by the corresponding "create" API.
default value: ""
For a full list of property names, see above.
Returns
The value of the specified property or tcl-error in case of error usage: ardi::item::table get -id $id -property parent

ardi::item::table getcell args

Queries the value on a cell identified by row and column ID. Row and column IDs start with 0.
Parameters
-id (mandatory)
value: item ID. The item ID which is returned by the corresponding "create" API.
default value: ""
-row (mandatory)
value: row ID. The ID of the row.
default value: ""
-column (mandatory)
value: column ID. The ID of the column.
default value: ""
-property (mandatory)
value: 'value', 'href', 'color', 'textcolor'. 'fontname', 'fontstyle', 'horizontal_alignment', and 'vertical_alignment'.
Returns
the value of the cell, tcl-error in case of error i.e ardi::api::item::table getcell -id $id -row 0 -column 0

ardi::item::table getheader args

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.
Parameters
-id (mandatory)
value: item ID. The item ID which is returned by the corresponding "create" API.
default value: ""
-row
value: row ID. The ID of the row you want to query the header text.
default value: ""
-column
value: column ID. The ID of the column you want to query the header text.
default value: ""
Returns
the header text
tcl-error in case of error i.e ardi::api::item::table getheader -id $id -column 1

ardi::item::table getpropertyid args

Queries id of property.
Parameters
-id
value: item ID
-key
value: property key

ardi::item::table getpropertykeylist args

Queries list of properties.
Parameters
-id
value: item ID
Returns
list of property keys for a particular item ID

ardi::item::table set args

Sets one or multiple parameters to specified values. The type of the item is assigned upon creation and cannot be changed after.
Parameters
-id (mandatory)
value: item ID. The item ID which is returned by the corresponding "create" API.
default value: ""
For a full list of property names, see above.
Returns
1 for ok
tcl-error in case of error i.e ardi::api::item::table set -id $id -name "My Table Item" -value "Good morning, how are you today?"

ardi::item::table setcell args

Sets the value on a cell identified by row and column ID. Row and column IDs start with 0.
Parameters
-id (mandatory)
value: item ID. The item ID which is returned by the corresponding "create" API.
default value: ""
-row (mandatory)
value: row ID. The ID of the row.
default value: ""
-column (mandatory)
value: column ID. The ID of the column.
default value: ""
-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, specify "-color 255,0,0"
-textcolor
value: Comma separated RGB color values.
Valid values: Comma separated RGB color values.
For green, specify "-textcolor 0,255,0"
-fontname
value: Font name.
Note that name 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'.
Styles can be combined 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 i.e ardi::api::item::table setcell -id $id -column 1 -value "My Header Text on column 1"

ardi::item::table setheader args

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.
Parameters
-id (mandatory)
value: item ID. The item ID which is returned by the corresponding "create" API.
default value: ""
-row
value: row ID. The ID of the row you want to set a particular header text.
default value: ""
-column
value: column ID. The ID of the column you want to set a particular header text.
default value: ""
-value
value: The text you want to set as header of the spcified row or column ID.
Returns
1 for ok
tcl-error in case of error i.e ardi::api::item::table setheader -id $id -column 1 -value "My Header Text on column 1"