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