ardi::item::exceldocument

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

ardi::item::exceldocument create args

Creates an item of type "exceldocument".

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::exceldocument create -name "My External Excel Document Item"

ardi::item::exceldocument 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::exceldocument delete -id $id

ardi::item::exceldocument 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: ""

Returns

For a full list of property names, see above.

ardi::item::exceldocument getcell args

Queries the value of one property from a table cell.

Parameters

-id (mandatory): value: item ID. The item ID which is returned by the corresponding "create" API.; default value: ""
-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.
-property (mandatory): value: property name. 'value' or 'href'.

Returns

The value of the specified property or tcl-error in case of error usage: ardi::item::exceldocument getcell -id $id -row 0 -column 0 -property value

Note: Available only when a Word report is exported without using platform-independent export.

ardi::item::exceldocument getpropertyid args

Queries id of property.

Parameters

-id: value: item ID
-key: value: property key

ardi::item::exceldocument getpropertykeylist args

Queries list of properties.

Parameters

-id: value: item ID

Returns

list of property keys for a particular item ID

ardi::item::exceldocument 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: ""

Returns

For a full list of property names, see above.

ardi::item::exceldocument setcell args

Sets one or multiple parameters to a table cell.

Parameters

-id (mandatory): value: item ID. The item ID which is returned by the corresponding "create" API.; default value: ""
-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 I.e ardi::api::item::exceldocument setcell -id $id -row 0 -column 0 -value "Hello" -href $refobjid.

Note: Available only when a Word report is exported without using platform-independent export.