rpti::item::textdocument

Interact with 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.

rpti::item::textdocument create

Creates an item of type "textdocument".

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

rpti::item::textdocument delete

Deletes the item with the specified ID.

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

rpti::item::textdocument get

Queries the value of one property.

Syntax
rpti::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 standard property names see Supported property name above.
Returns
The value of the specified property or .tcl-error in case of error.
Example
rpti::item::textdocument get -id $id -property parent

rpti::item::textdocument getpropertyid

Queries ID of property.

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

rpti::item::textdocument getpropertykeylist

Queries list of properties

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

rpti::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
rpti::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 standard property names see Supported property name above.
Returns
1 for OK, .tcl-error in case of error.
Example
rpti::item::textdocument set -id $id -name "My External Excel Document" -file "c:/temp/textdocument.txt"