ardi.item

Report Item: access/modify Report Items.

ardi.item.chapter

Interact with items of type chapter. This item type is valid only for document 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

Creates an item of type "chapter".

Syntax
ardi.item.chapter.create
Parameters
For
Value: A full list of property names see "Supported property names" above.
Returns
The ID of the item or Python-error in case an error occurred during creation.
Example
ardi.item.chapter.create -name "My Chapter Item"

ardi.item.chapter.delete

Deletes the item with the specified ID.

Syntax
ardi.item.chapter.delete
Parameters
-id
Mandatory value: Item ID. The item ID which is returned by the corresponding "create" API.
Returns
1 for OK, Python-error in case of error.
Example
ardi.item.chapter.delete -id $id

ardi.item.chapter.get

Queries the value of one property.

Syntax
ardi.item.chapter.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 names" above.
Returns
The value of the specified property or Python-error in case of error.
Example
ardi.item.chapter.get -id $id -property parent

ardi.item.chapter.set

Sets one or multiple parameters to specified values. The type of the item is assigned upon creation and cannot be changed after.

Syntax
ardi.item.chapter.set
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 names" above.
Returns
1 for OK, Python-error in case of error.
Example
ardi.item.chapter.set -id $id -name "My Chapter Item" -value "Good monring, how are you today?"

ardi.item.chapter.hasproperty

Check if the item has property with specified key.

Syntax
ardi.item.chapter.hasproperty
Parameters
-id
Value: Item ID.
-key
Value: Property key.
Returns
1 if valid, 0 if invalid.

ardi.item.exceldocument

Interact with items of type exceldocument.

Supported property names are:-name-value-parent-type (read only)-file-sheet-caption-capitalisation.

All properties available can be passed via the "create" API or modified on an existing item via the "set" API.

ardi.item.exceldocument.create

Creates an item of type "exceldocument".

Syntax
ardi.item.exceldocument.create
Parameters
For
Value: A full list of property names see "Supported property names" above.
Returns
The ID of the item or Python-error in case an error occurred during creation.
Example
ardi.item.exceldocument.create -name "My External Excel Document Item"

ardi.item.exceldocument.delete

Deletes the item with the specified ID.

Syntax
ardi.item.exceldocument.delete
Parameters
-id
Mandatory value: Item ID. The item ID which is returned by the corresponding "create" API.
Returns
1 for OK, Python-error in case of error.
Example
ardi.item.exceldocument.delete -id $id

ardi.item.exceldocument.get

Queries the value of one property.

Syntax
ardi.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 names" above.
Returns
The value of the specified property or Python-error in case of error.
Example
ardi.item.exceldocument.get -id $id -property parent

ardi.item.exceldocument.getcell

Queries the value of one property from table cell.

Syntax
ardi.item.exceldocument.getcell
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.
-property
Mandatory value: Property name. 'value' or 'href'
Returns
The value of the specified property or Python-error in case of error.
Example
ardi.item.exceldocument.getcell -id $id -row 0 -column 0 -property values

ardi.item.exceldocument.getpropertyid

Queries id of property.

Syntax
ardi.item.exceldocument.getpropertyid
Parameters
-id
Value: Item ID.
-key
Value: Property key.

ardi.item.exceldocument.getpropertykeylist

Queries list of properties.

Syntax
ardi.item.exceldocument.getpropertykeylist
Parameters
-id
Mandatory value: Item ID. The item ID which is returned by the corresponding "create" API.
-row
Value: Item ID.
Returns
List of property keys for a particular item ID.

ardi.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
ardi.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 property names see "Supported property names" above.
Returns
1 for OK, Python-error in case of error.
Example
ardi.item.exceldocument.set -id $id -name "My External Excel Document" -file "c:/temp/mydoc.xlsx"

ardi.item.exceldocument.setcell

Sets one or multiple parameters to table cell.

Syntax
ardi.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, Python-error in case of error.
Example
ardi.item.exceldocument.setcell -id $id -row 0 -column 0 -value "Hello" -href $refobjid

ardi.item.image

Interact with items of type 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

Creates an item of type "image".

Syntax
ardi.item.image.create
Parameters
For
Value: A full list of property names see "Supported property names" above.
Returns
The ID of the item or Python-error in case an error occurred during creation.
Example
ardi.item.image.create -name "My Image Item"

ardi.item.image.delete

Deletes the item with the specified ID.

Syntax
ardi.item.image.delete
Parameters
-id
Mandatory value: Item ID. The item ID which is returned by the corresponding "create" API.
Returns
1 for OK, Python-error in case of error.
Example
ardi.item.image.delete -id $id

ardi.item.image.get

Queries the value of one property.

Syntax
ardi.item.image.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 names" above.
Returns
The value of the specified property or Python-error in case of error.
Example
ardi.item.image.get -id $id -property parent

ardi.item.image.set

Sets one or multiple parameters to specified values. The type of the item is assigned upon creation and cannot be changed after.

Syntax
ardi.item.image.set
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 names" above.
Returns
1 for OK, Python-error in case of error.
Example
ardi.item.image.set -id $id -name "My Image Item" -value "Good monring, how are you today?"

ardi.item.module

ardi.item.module.create

Creates an item of type "module".

Syntax
ardi.item.module.create

ardi.item.module.delete

Deletes the item with the specified ID.

Syntax
ardi.item.module.delete
Parameters
-id
Mandatory value: Item ID.
Returns
1 for OK, Python-error in case of error.

ardi.item.module.get

Gets property value of an Item.

Syntax
ardi.item.module.get

ardi.item.module.set

Sets property value of an Item.

Syntax
ardi.item.module.set

ardi.item.pagebreak

ardi.item.pagebreak.create

Creates an item of type "break".

Syntax
ardi.item.pagebreak.create
Parameters
For
Value: A full list of property names see "Supported property names" above.
Returns
The ID of the item or Python-error in case an error occurred during creation.
Example
ardi.item.pagebreak.create -name "My Image Item"

ardi.item.pagebreak.delete

Deletes the item with the specified ID.

Syntax
ardi.item.pagebreak.delete
Parameters
-id
Mandatory value: Item ID. The item ID which is returned by the corresponding "create" API.
Returns
1 for OK, Python-error in case of error.
Example
ardi.item.pagebreak.delete -id $id

ardi.item.pagebreak.get

Queries the value of one property.

Syntax
ardi.item.pagebreak.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 names" above.
Returns
The value of the specified property or Python-error in case of error.
Example
ardi.item.pagebreak.get -id $id -property parent

ardi.item.pagebreak.set

Sets one or multiple parameters to specified values. The type of the item is assigned upon creation and cannot be changed after.

Syntax
ardi.item.pagebreak.set
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 names" above.
Returns
1 for OK, Python-error in case of error.
Example
ardi.item.pagebreak.set -id $id -name "My Image Item" -value "Good monring, how are you today?"

ardi.item.property

ardi.item.property.create

Creates an item of type "property".

Syntax
ardi.item.property.create
Parameters
-id
Mandatory value: Parent item ID of type text, image, table, module\parent.
-key
Mandatory value: Unique key/name for the property.
-name
Value: "Display name of the property, if not specified key is used as display name".
-type
(defaults to str): Type of property.
For
Value: A full list of property names see "Supported property names" above.
Returns
The ID of the item or Python-error in case an error occurred during creation.
Example
ardi.item.property.create -id $parentid -key "MyKey" -name "My Property" -value "My Value" -type "str"

ardi.item.property.delete

Deletes the item with the specified ID.

Syntax
ardi.item.property.delete
Parameters
-id
Mandatory value: Parent item ID of type text,image,table,module etc, \parem
-name
Mandatory value: Name of the property.
Returns
1 for OK, Python-error in case of error.
Example
ardi.item.property.delete -id $id

ardi.item.property.get

Queries the value of one property.

Syntax
ardi.item.property.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 names" above.
-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 Python-error in case of error.
Example
ardi.item.property.get -id $id -property parent

ardi.item.property.set

Sets name and value of specific property.

Syntax
ardi.item.property.set
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 names" above.
Returns
1 for OK, Python-error in case of error.
Example
ardi.item.property.set(id=itemid,value="Test")

ardi.item.slide

ardi.item.slide.create

Creates an item of type "slide".

Syntax
ardi.item.slide.create
Parameters
For
Value: A full list of property names see "Supported property names" above.
Returns
The ID of the item or Python-error in case an error occurred during creation.
Example
ardi.item.slide.create -name "My Slide Item"

ardi.item.slide.delete

Deletes the item with the specified ID.

Syntax
ardi.item.slide.delete
Parameters
-id
Mandatory value: Item ID. The item ID which is returned by the corresponding "create" API.
Returns
1 for OK, Python-error in case of error.
Example
ardi.item.slide.delete(id=itemid)

ardi.item.slide.get

Queries the value of one property.

Syntax
ardi.item.slide.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 names" above.
Returns
The value of the specified property or Python-error in case of error.
Example
ardi.item.slide.get -id $id -property parent

ardi::item::slide set

Sets one or multiple parameters to specified values. The type of the item is assigned upon creation and cannot be changed after.

Syntax
ardi::item::slide set
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 names" above.
Returns
1 for OK, Python-error in case of error.
Example
ardi.item.slide.set(id=itemid,name="My Slide Item",value="Good monring, how are you today?")

ardi.item.table.

Interact with items of type table.

Supported property names are:-name-value-parent-type (read only)-numberless-numberofcolumns -showcolumnheader-showrowheader.

All properties available can be passed via the "create" API or modified on an existing item via the "set" API.

ardi.item.table.create

Creates an item of type "table".

Syntax
ardi.item.table.create
Parameters
For
Value: A full list of property names see "Supported property names" above.
Returns
The ID of the item or Python-error in case an error occurred during creation.
Example
ardi.item.table.create -name "My Table Item"

ardi.item.table.delete

Deletes the item with the specified ID.

Syntax
ardi.item.table.delete
Parameters
-id
Mandatory value: Item ID. The item ID which is returned by the corresponding "create" API.
Returns
1 for OK, Python-error in case of error.
Example
ardi.item.table.delete -id $id

ardi.item.table.get

Queries the value of one property.

Syntax
ardi.item.table.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 names" above.
Returns
The value of the specified property or Python-error in case of error.
Example
ardi.item.table.get -id $id -property parent

ardi.item.table.getcell

Queries the value on a cell identified by row and column ID. Row and column IDs start with 0.

Syntax
ardi.item.table.getcell
Parameters
-id
Mandatory value: Item ID. The item ID which is returned by the corresponding "create" API.
-row
Mandatory value: Row ID. The ID of the row.
-column
Mandatory value: Column ID. The ID of the column.
-property
Mandatory value: 'value', 'href', 'color', 'textcolor', 'fontname', 'fontstyle', 'horizontal_alignment' and 'vertical_alignment'.
Returns
The value of the cell, Python-error in case of error.
Example
ardi.item.table.getcell(id=itemid,row=0,column=0)

ardi.item.table.getheader

Queries the header text on a row or on a column. Row and column IDs start with 1. Specify either row or column ID to query the current value.

Syntax
ardi.item.table.getheader
Parameters
-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 query the header text.
-column
Value: Column ID. The ID of the column you want to query the header text.
Returns
The header text, Python-error in case of error.
Example
ardi.item.table.getheader -id $id -column 1

ardi.item.table.set

Sets one or multiple parameters to specified values. The type of the item is assigned upon creation and cannot be changed after.

Syntax
ardi.item.table.set
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 names" above.
-column
Mandatory value: Column ID. Column ID is an integer starting from 0.
Returns
1 for OK, Python-error in case of error.
Example
ardi.item.table.set -id $id -name "My Table Item" -value "Good monring, how are you today?"

ardi.item.table.setcell

Sets the value on a cell identified by row and column ID. Row and column IDs start with 0.

Syntax
ardi.item.table.setcell
Parameters
-id
Mandatory value: Item ID. The item ID which is returned by the corresponding "create" API.
-row
Mandatory value: Row ID. The ID of the row.
-column
Mandatory value: Column ID. The ID of the column.
-value
Value: The value you want to set on the cell.
-href
Value: Object ID to set cross-reference to.
Returns
1 for OK, Python-error in case of error.
Example
ardi.item.table.setcell -id $id -column 1 -value "My Header Text on column 1"

ardi.item.table.setheader

Sets the header text on a row or on a column. Row and column IDs start with 0. Specify either row or column ID to set the header text to desired value.

Syntax
ardi.item.table.setheader
Parameters
-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.
-value
Value: The text you want to set as header of the specified row or column ID.
Returns
1 for OK, Python-error in case of error.
Example
ardi.item.table.setheader(id=itemid,column=1,value="My Header Text on column 1") i.e ardi.item.table.setheader(id=itemid,row=2,value="My Row Header")

ardi.item.tableofreference

Interact with items of type tableofreference.

Supported property names are: -name-value-parent.

All properties available can be passed via the "create" API or modified on an existing item via the "set" API. After creation all the properties that applies for table type can be used.

ardi.item.tableofreference.create

Creates an item of type "tableofreference".

Syntax
ardi.item.tableofreference.create
Parameters
For
Value: A full list of property names see "Supported property names" above.
Returns
The ID of the item type table or Python-error in case an error occurred during creation.

ardi.item.tableofreference.delete

Deletes the item with the specified ID.

Syntax
ardi.item.tableofreference.delete
Parameters
-id
Mandatory value: Item ID. The item ID which is returned by the corresponding "create" API.
Returns
1 for OK, Python-error in case of error.
Example
ardi.item.tableofreference.delete(id=itemid)

ardi.item.tableofreference.get

Queries the value of one property.

Syntax
ardi.item.tableofreference.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 names" above.
Returns
The value of the specified property or Python-error in case of error.
Example
ardi.item.tableofreference.get(id=itemid,property='parent')

ardi.item.tableofreference.set

Sets one or multiple parameters to specified values. The type of the item is assigned upon creation and cannot be changed after.

Syntax
ardi.item.tableofreference.set
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 names" above.
Returns
1 for OK, python-error in case of error.
Example
ardi.item.tableofreference.set(id=itemid,name="My Table of References" -parent $parentid"

ardi.item.text

Interact with items of type text.

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.text.create

Creates an item of type "text".

Syntax
ardi.item.text.create
Parameters
For
Value: A full list of property names see "Supported property names" above.
Returns
The ID of the item or Python-error in case an error occurred during creation.
Example
ardi.item.text.create(name="Text1",value="My Text Content")

ardi.item.text.delete

Deletes the item with the specified ID.

Syntax
ardi.item.text.delete
Parameters
-id
Mandatory value: Item ID. The item ID which is returned by the corresponding "create" API.
Returns
1 for OK, Python-error in case of error.
Example
ardi.item.text delete(id=itemid)

ardi.item.text.get

Queries the value of one property.

Syntax
ardi.item.text.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 names" above.
Returns
The value of the specified property or Python-error in case of error.
Example
ardi.item.text.get(id=itemid,property='parent')

ardi.item.text.getcrossref

Queries the cross reference within text item.

Syntax
ardi.item.text.getcrossref
Parameters
-id
Mandatory value: Item ID. The item ID which is returned by the corresponding "create" API.

ardi.item.text.set

Sets one or multiple parameters to specified values. The type of the item is assigned upon creation and cannot be changed after.

Syntax
ardi.item.text.set
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 names" above.
Returns
1 for OK, -Python-error in case of error.
Example
ardi.item.text.set(id=itemid,name="My Text Item",value="Good monring, how are you today?")

ardi.item.text.setcrossref

Sets the cross reference within text item.

Syntax
ardi.item.text.setcrossref

ardi.item.textdocument

Interact with items of type textdocument.

Supported property names are:-name-file-parent.

All properties available can be passed via the "create" API or modified on an existing item via the "set" API.

ardi.item.textdocument.create

Creates an item of type "textdocument".

Syntax
ardi.item.textdocument.create
Parameters
For
Value: A full list of property names see "Supported property names" above.
Returns
The ID of the item or Python-error in case an error occurred during creation.
Example
ardi.item.textdocument.create(name="My Text File",file="example.txt")

ardi.item.textdocument.delete

Deletes the item with the specified ID.

Syntax
ardi.item.textdocument.delete
Parameters
-id
Mandatory value: Item ID. The item ID which is returned by the corresponding "create" API.
Returns
1 for OK, Python-error in case of error.
Example
ardi.item.textdocument.delete(id=itemid)

ardi.item.textdocument.get

Queries the value of one property.

Syntax
ardi.item.textdocument.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 names" above.
Returns
The value of the specified property or Python-error in case of error.
Example
ardi.item.textdocument.get(id=itemid,property='parent')

ardi::item::textdocument.set

Sets one or multiple parameters to specified values. The type of the item is assigned upon creation and cannot be changed after.

Syntax
ardi::item::textdocument.set
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 names" above.
Returns
1 for OK, Python-error in case of error.
Example
ardi.item.textdocument.set(id=itemid,name="My External Excel Document",file= "c:/temp/textdocument.txt")

ardi.item.worddocument

Interact with items of type worddocument.

Supported property names are:-name-file-parent.

All properties available can be passed via the "create" API or modified on an existing item via the "set" API.

ardi.item.worddocument.create

Creates an item of type "worddocument".

Syntax
ardi.item.worddocument.create
Parameters
For
Value: A full list of property names see "Supported property names" above.
Returns
The ID of the item or python-error in case an error occurred during creation.
Example
ardi.item.worddocument.create(name="My Word Document",file="example.docx")

ardi.item.worddocument.delete

Deletes the item with the specified ID.

Syntax
ardi.item.worddocument.delete
Parameters
-id
Mandatory value: Item ID. The item ID which is returned by the corresponding "create" API.
Returns
1 for OK, Python-error in case of error.
Example
ardi.item.worddocument.delete(id=itemid)

ardi.item.worddocument.get

Queries the value of one property.

Syntax
ardi.item.worddocument.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 names" above.
Returns
The value of the specified property or Python-error in case of error.
Example
ardi.item.worddocument.get(id=itemid,property='parent')

ardi.item.worddocument.set

Sets one or multiple parameters to specified values. The type of the item is assigned upon creation and cannot be changed after.

Syntax
ardi.item.worddocument.set
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 names" above.
Returns
1 for OK, Python-error in case of error.
Example
ardi.item.worddocument.set(id=itemid,name="My External Word Document",file ="c:/temp/example.docx"

ardi.item.apply

For better performance data created, manipulated or deleted go into a cache.

Syntax
ardi.item.apply
Parameters
-name
Value: Layout name to use in case of presentation.
-itemlist
Value: List of item ids to apply.
-parent
Value: parent of the cached items. If not specified root item will act as a parent. This API processes the cached data, clears the cache and redraws the GUI if needed.
-property
Mandatory value: Property name. 'value' or 'href'.
Returns
1 for OK, Python-error in case of error.

ardi.item.delete

Deletes the item with the specified ID.

Syntax
ardi.item.delete
Parameters
-id
Value: Item ID.
Returns
1 for OK, Python-error in case of error.

ardi.item.get

Queries the value of one property or role or attribute.

Syntax
ardi.item.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 names" above.
Returns
The value of the specified property/role/attribute or python-error in case of error.
Example
ardi.item.get -id $id -property parent
ardi.item.get -id $id -role rolename
ardi.item.get-id $id -attribute attributename

ardi.item.getpropertyid

Queries ID of property.

Syntax
ardi.item.getpropertyid
Parameters
-id
Value: Item ID.
-key
Value: Property key.

ardi.item.getpropertykeylist

Queries list of properties.

Syntax
ardi.item.getpropertykeylist
Parameters
-id
Value: Item ID.
Returns
List of property keys for a particular item ID.

ardi.item.getslidelayouts

Queries slide based layouts.

Syntax
ardi.item.getslidelayouts
Returns
The list of slide layout IDs.

ardi.item.getmasterlayouts

Queries master layouts.

Syntax
rdi.item.getmasterlayouts
Returns
The list of master layout ID's.

ardi.item.gettype

Queries the type of the item with the specified ID.

Syntax
ardi.item.gettype
Parameters
-id
Value: Item ID.
Returns
The type of the item.

ardi.item.gettypelist

Queries available types of items.

Syntax
ardi.item.gettypelist
Returns
A list of item types.

ardi.item.hasproperty

Check if the item has property with specified key.

Syntax
ardi.item.hasproperty
Parameters
-id
Value: Item ID.
-key
Value: Property key.
Returns
1 if valid, 0 if invalid.

ardi.item.isvalid

Check if the item with the specified ID is valid.

Syntax
ardi.item.isvalid
Parameters
-id
Value: Item ID.
Returns
1 if valid, 0 if invalid.

ardi.item.set

Sets one or multiple parameters to specified values.

Syntax
ardi.item.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 names" above. Use rpti::item getpropertykeylist for list of dynamic properties.
Returns
1 for OK, Python-error in case of error.
Example
ardi.item.set -id $id -name "My Text Item" -value "Good monring, how are you today?"