Difference between revisions of "API Component.Property.GetListItem"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
|||
| (16 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | |
| − | == | + | |- |
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetListItem''' | ||
| + | |- | ||
| + | | colspan="2" | Gets a single list entry from a property by named index | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | ||
| + | | width="90%" | Handle | ||
| + | |- | ||
| + | | colspan="2" | The component handle to get the property of | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | ||
| + | | width="90%" | Property | ||
| + | |- | ||
| + | | colspan="2" | The textual name of the property | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | ||
| + | | width="90%" | Index | ||
| + | |- | ||
| + | | colspan="2" | The text or integer entry of the property | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING | ||
| + | | width="90%" style="border-top: 2px solid #000;" | ''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 [[API Component.Property.GetListIndex|GetListIndex]]. | |
| − | |||
| − | |||
| − | + | ==Examples== | |
| − | + | ===Calling in a calculation=== | |
* Declare a variable 'result' of type STRING | * Declare a variable 'result' of type STRING | ||
| − | * Add to a calculation icon: result = ::Component.Property.GetListItem(handle, "property", "index") | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.Property.GetListItem(handle, "property", "index")</pre> |
Latest 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")
