rpti::item::text
Interact with items of type text.
- Supported Property Names
- To set text properties, use the following properties:
rpti::item::text create
Creates an item of type "text".
- Syntax
rpti::item::text 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::text create -name "My Text Item"
rpti::item::text delete
Deletes the item with the specified ID.
- Syntax
rpti::item::text 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::text delete -id $id
rpti::item::text get
Queries the value of one property.
- Syntax
rpti::item::text getreport::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 name above.
- Returns
- The value of the specified property or .tcl-error in case of error.
- Example
rpti::item::text get -id $id -property parent
rpti::item::text getcrossref
Queries the cross reference within text item.
- Syntax
rpti::item::text getcrossref
- Parameters
-
- -id
- Mandatory value: Item ID. The item ID which is returned by the corresponding "create" API.
rpti::item::text getpropertyid
Queries ID of property.
- Syntax
rpti::item::text getpropertyid
- Parameters
-
- -id
- Value: Item ID.
- -key
- Value: Property key.
rpti::item::text getpropertykeylist
Queries list of properties
- Syntax
rpti::item::text getpropertykeylist
- Parameters
-
- -id
- Mandatory value: Item ID.
- Returns
- List of property keys for a particular item ID.
rpti::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
rpti::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 standard property names see Supported property name above.
- Returns
- 1 for OK, .tcl-error in case of error.
- Example
rpti::item::text set -id $id -name "My Text Item" -value "Good monring, how are you today?"
rpti::item::text setcrossref
Sets the cross reference within text item.
- Syntax
rpti::item::text setcrossref
- Parameters
-
- -id
- Mandatory value: Item ID. The item ID which is returned by the corresponding "create" API.
- -value
- Mandatory value: {location refobjid}. location: {startposition endposition}. Position is <lineno>.<charindex>. endposition is not included inside the reference link. Refer to usage section for reference.
- Example
set textid [rpti::item::text create -name "Crossref-demo" -value "Text Box Link: Href"] rpti::item::text setcrossref -id $textid -value {{1.15 1.19} $tbox1id}"