ardi::item::exceldoc

Interact with items of type exceldoc.

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::exceldoc::create args

Creates an item of type "exceldoc".
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::exceldoc create -name "My External Excel Document Item"

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

ardi::item::exceldoc::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::exceldoc::getpropertyid args

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

ardi::item::exceldoc::getpropertykeylist args

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

ardi::item::exceldoc::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.