rpti::item::worddocument
Interact with items of type worddocument.
- Supported Property Names
-name -file -parent
rpti::item::worddocument create
Creates an item of type "worddocument".
- Syntax
rpti::item::worddocument 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::worddocument create -name "My Word Document" -file "example.docx"
rpti::item::worddocument delete
Deletes the item with the specified ID.
- Syntax
rpti::item::worddocument 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::worddocument delete -id $id
rpti::item::worddocument get
Queries the value of one property.
- Syntax
rpti::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 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::worddocument get -id $id -property parent
rpti::item::worddocument getpropertyid
Queries ID of property.
- Syntax
rpti::item::worddocument getpropertyid
- Parameters
-
- -id
- Value: Item ID.
- -key
- Value: Property key.
rpti::item::worddocument getpropertykeylist
Queries list of properties
- Syntax
rpti::item::worddocument getpropertykeylist
- Parameters
-
- -id
- Value: Item ID.
- Returns
- List of property keys for a particular item id.
rpti::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
rpti::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 standard property names see Supported property name above.
- Returns
- 1 for OK, .tcl-error in case of error.
- Example
rpti::item::worddocument set -id $id -name "My External Word Document" -file "c:/temp/example.docx"