report::item

set item [::rpti::item getinterface -name
            new_report_session1]

report:item apply

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

Syntax: $item apply

Parameters

-name: Value: Layout name to use in case of presentation.

-item list: Value: List of item ids to apply.

-parent: Value: parent of the cached items. If not specified root item will act as a parent.; Note: This API processes the cached data, clears the cache and redraws the GUI if needed.

Returns: 1 for OK, .tcl-error in case of error.

report::item clone

Clone an Item.

Syntax: $item clone

Parameters

-id: Value: Item ID

Returns: New item ID.

report::item createchapter

Creates an item of type "chapter".

Supported Property Names: -name -value -parent -type (read only)

Syntax: $item createchapter

Returns: The ID of the item or .tcl-error in case an error occurred during creation, that is, $item_i createchapter -name "My Chapter Item".

report::item createimage

Creates an item of type image.

Supported Property Names: -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.

Syntax: $item createimage

Returns: The ID of the item or .tcl-error in case an error occurred during creation.

report::item createslide

Creates an item of type slide. This item type is valid only for presentation reports.

Supported Property Names: -name -value -parent -type (read only) -layoutname or -index-layoutname -> name of the layout-index -> slideindex starts from 1; All properties available can be passed via the "create" API or modified on an existing item via the "set" API.

Syntax: $item createslide

Returns: The ID of the item or .tcl-error in case an error occurred during creation.

report::item createtable

Creates an item of type table.

Supported Property Names: -name -value -parent -type (read only) -numberofrows -numberofcolumns -showcolumnheader -showrowheader; All properties available can be passed via the "create" API or modified on an existing item via the "set" API.

Syntax: $item createtable

Returns: The ID of the item or .tcl-error in case an error occurred during creation.

report::item createtext

Creates an item of type text.

Supported Property Names: -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.

Syntax: $item createtext

Returns: The ID of the item or .tcl-error in case an error occurred during creation.

report::item createbreak

Creates an item of type break.

Supported Property Names: -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.

Syntax: $item createbreak

Returns: The ID of the item or .tcl-error in case an error occurred during creation.

report::item createtextdocument

Create items of type textdocument.

Supported Property Names: -name -file -parent; All properties available can be passed via the "create" API or modified on an existing item via the "set" API.

Syntax: $item createtextdocument

Returns: The ID of the item or .tcl-error in case an error occurred during creation.

report::item createworddocument

Create items of type worddocument.

Supported Property Names: -name -file -parent; All properties available can be passed via the "create" API or modified on an existing item via the "set" API.

Syntax: $item createworddocument

Returns: The ID of the item or .tcl-error in case an error occurred during creation.

report::item createexceldocument

Create items of type exceldocument.

Supported Property Names: -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.

Syntax: $item createexceldocument

Returns: The ID of the item or .tcl-error in case an error occurred during creation.

report::item createtableofreference

Create items of type tableofreference.

Supported Property Names: -name -value -parent; All properties available can be passed via the "create" API or modified on an existing item via the "set" API.

Syntax: $item createtableofreference

Returns: The ID of the item or .tcl-error in case an error occurred during creation.

report::item createexternalobject

Create items of type externalobject.

Supported Property Names: -name -file -parent; All properties available can be passed via the "create" API or modified on an existing item via the "set" API.

Syntax: $item createexternalobject

Returns: The ID of the item or .tcl-error in case an error occurred during creation.

report::item delete

Deletes the item with the specified ID.

Syntax: $item delete

Parameters

-id: Value: Item ID

Returns: 1 for OK, .tcl-error in case of error

report::item get

Queries the value of one property or role or attribute.

Syntax: $item get

Parameters

-id: Mandatory value: Item ID. The item ID which is returned by the corresponding "create" API.

For: Value: Use rpti::item getpropertykeylist for list of dynamic properties.

Returns: The value of the specified property/role/attribute or .tcl-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

report::item getattribute

Get item attribute.

Syntax: $item getattribute

Parameters

-id: Value: Item ID

-name: Value: Attribute Name

Returns: Attribute value.

report::item getmasterlayouts

Queries master layouts.

Syntax: $item getmasterlayouts

Returns: The list of master layout ID's.

report::item getpropertyid

Queries ID of property.

Syntax: $item getpropertyid

Parameters

-id: Value: Item ID

-key: Value: Property key

report::item getpropertykeylist

Queries list of properties.

Syntax: $item getpropertykeylist

Parameters

-id: Value: Item ID

Returns: List of property keys for a particular item ID.

report::item getrole

Get item role.

Syntax: $item getrole

Parameters

-id: Value: Item ID

-name: Value: Role Name

Returns: Role value.

report::item getroot

Queries the ID of the report root item. This is the top most item.

Syntax: $item getroot

Returns: The ID of the report root item.

report::item getselection

Queries current selected item.

Syntax: $item getselection

Returns: Selected item ID.

report::item getslidelayouts

Queries slide based layouts.

Syntax: $item getslidelayouts

Returns: The list of slide layout ID's.

report::item gettype

Queries the type of the item with the specified ID.

Syntax: $item gettype

Parameters

-id: Value: Item ID

Returns: The type of the item.

report::item gettypelist

Queries available types of items.

Syntax: $item gettypelist

Returns: A list of item types.

report::item hasattribute

Check if an item attribute exists.

Syntax: $item hasattribute

Parameters

-id: Value: Item ID

-name: Value: Attribute name

Returns: 1 if role exists, 0 if role does not exist.

report::item hasproperty

Check if the item has property with specified key.

Syntax: $item hasproperty

Parameters

-id: Value: Item ID

-key: Value: Property key.

Returns: 1 if valid , 0 if invalid.

report::item hasrole

Check if an item role exists.

Syntax: $item hasrole

Parameters

-id: Value: Item ID

-name: Value: Role name.

Returns: 1 if role exists, 0 if role does not exist.

report::item insert

Insert an item to a parent.

Syntax: $item insert

Parameters

-id: Value: Item ID to insert. \parent -parent parentitemid: parent item id

-index: Value: Index in parent

Returns: 1 if success, error message if failed.

report::item isleaf

Check if the item is a leaf.

Syntax: $item isleaf

Parameters

-id: Value: Item ID

Returns: 1 if valid, 0 if invalid.

report::item isvalid

Check if the item with the specified ID is valid.

Syntax: $item isvalid

Parameters

-id: Value: Item ID

Returns: 1 if valid, 0 if invalid.

report::item loadproperty

Load items properties defined in configuration .xml.

Syntax: $item loadproperty

Parameters

-id: Value: Item ID

Returns: 1 if success, error message if failed.

report::item redraw

Notifies all registered views to redraw itself.

Syntax: $item redraw

report::item remove

Remove an item from parent.

Syntax: $item remove

Parameters

-id: Value: Item ID to remove.

Returns: 1 if success, error message if failed.

report::item removerole

Remove item role if exists.

Syntax: $item removerole

Parameters

-id: Value: Item ID

-name: Value: Role name.

report::item reparent

Re parents an object that already has a parent.

Syntax: $item reparent

Parameters

-id: Value: Item ID to reparent. \parent -newparent parentitemid: New parent item id

-index: Value: Index in parent

Returns: 1 if success, error message if failed.

report::item set

Sets one or multiple parameters to specified values.

Syntax: $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, .tcl-error in case of error.

Example: $item set -id $id -name "My Text Item" -value "Good monring, how are you today?"

report::item setattribute

Sets/update item attribute.

Syntax: $item setattribute

Parameters

-id: Value: Item ID

-name: Value: Attribute Name usually a string

-value: Value: Attribute Value

Returns: 1 if success, error message if failed.

report::item setrole

Set/update item role

Syntax: $item setrole

Parameters

-id: Value: Item ID

-name: Rolename: Role Name usually a string

-value: Rolevalue: Role Value

Returns: 1 if success, error message if failed.

report::item setselection

Queries current selected item set using rpti::item setselection.

Syntax: $item setselection

Parameters: None.

Returns: Selected item ID.

report::item validate

Evaluates registered validate callback.

Syntax: $item validate

Parameters

-id: Itemid: Item ID.

Returns: -1 if errors, 0 if warnings and 1 if passed.