ardi::item::image

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

ardi::item::image create args

Creates an item of type "image".

Parameters: For a full list of property names, see above.; Use -value to point to an image.
Returns: The ID of the item or tcl-error in case an error occurred during creation. For example, ardi::item::image create -name -value "C:/Report Images/myimage.png"

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

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

Queries id of property.

Parameters

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

ardi::item::image getpropertykeylist args

Queries list of properties.

Parameters

-id: value: item ID

Returns

list of property keys for a particular item ID

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