Difference between revisions of "API Component.Property.GetListItem"
From Flowcode Help
Jump to navigationJump to search (XML import of API documentation) |
(XML import) |
||
| Line 1: | Line 1: | ||
| − | |||
| − | |||
<sidebar>API Contents</sidebar> | <sidebar>API Contents</sidebar> | ||
Gets a single list entry from a property by named index | Gets a single list entry from a property by named index | ||
Revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Gets a single list entry from a property by named index
Contents
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. 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")
No additional examples
