API Component.Property.GetListItem: Difference between revisions
No edit summary |
No edit summary |
||
| Line 41: | Line 41: | ||
* Declare a variable 'result' of type STRING | * Declare a variable 'result' of type STRING | ||
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.Property.GetListItem(handle, "property", "index")</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.Property.GetListItem(handle, "property", "index")</pre> | ||
Revision as of 11:54, 16 January 2023
|
GetListItem |
| Gets a single list entry from a property by named index | |
 - HANDLE
|
Handle |
| The component handle to get the property of | |
 - STRING
|
Property |
| The textual name of the property | |
| - STRING
|
Index |
| The text or integer entry of the property | |
| - STRING
|
Return |
Detailed description
Gets the text part of a list property identified by its 3-digit Index'.
Note the Index is not the line of the list to extract, but the 3-digit identifier. If multiple lines have the same identifier this will extract the first found.
To find the index from the line, use GetListIndex.
Examples
Calling in a calculation
- Declare a variable 'result' of type STRING
- Add to a calculation icon:
result = ::Component.Property.GetListItem(handle, "property", "index")