API Component.Property.GetListItem: Difference between revisions
XML Import to change Variable types into Variable Types |
No edit summary |
||
| Line 28: | Line 28: | ||
==Detailed description== | ==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. Ifmultiple lines have the same identifier this will extract the first found. | |||
To find the index from the line, use [[API Component.Property.GetListIndex|GetListIndex]]. | |||
Revision as of 23:05, 11 June 2013
<sidebar>API contents</sidebar> Gets a single list entry from a property by named index
Parameters
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
Return value
Returns the single list entry from a property by named index
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. Ifmultiple 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")
No additional information