ardi::item::chapter

This item type is valid only for MS-Word reports. Supported property names are: -name -value -parent -type (read only) All properties available can be passed via the "create" API or modified on an existing item via the "set" API.

ardi::item::chapter::create args

Creates an item of type "chapter".

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::chapter create -name "My Chapter Item"

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

ardi::item::chapter::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::chapter get -id $id -property parent

ardi::item::chapter::getpropertyid args

Queries id of property.

Parameters

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

ardi::item::chapter::getpropertykeylist args

Queries list of properties.

Parameters

-id: value: item ID

Returns

list of property keys for a particular item ID

ardi::item::chapter::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::chapter set -id $id -name "My Chapter Item" -value "Good morning, how are you today?"