API Component.Property.GetListItem: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	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")

@@ Line 1: / Line 1: @@
+{| class="mtx-class-macrotable wikitable"
+|-
-<sidebar>API contents</sidebar>
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-Gets a single list entry from a property by named index
+| width="90%" class="mtx-class-macrohead" | '''GetListItem'''
+|-
-<div style="width:25%; float:right" class="toc">
+| colspan="2" | Gets a single list entry from a property by named index&nbsp;
-====Class hierarchy====
+|-
-[[API Component|Component]]
+|-
-:[[API Component.Property|Property]]
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
-::[[API Component.Property|GetListItem]]
+| width="90%" | Handle
-</div>
+|-
-__TOC__
+| colspan="2" | The component handle to get the property of&nbsp;
+|-
-==Parameters==
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
-[[Variable Types|HANDLE]] ''Handle''
+| width="90%" | Property
-:The component handle to get the property of
+|-
+| colspan="2" | The textual name of the property&nbsp;
-[[Variable Types|STRING]] ''Property''
+|-
-:The textual name of the property
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | Index
-[[Variable Types|STRING]] ''Index''
+|-
-:The text or integer entry of the property
+| colspan="2" | The text or integer entry of the property&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
-==Return value==
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
-[[Variable Types|STRING]]
+|}
-Returns the single list entry from a property by named index
@@ Line 43: / Line 41: @@
 * Declare a variable 'result' of type STRING
 * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.Property.GetListItem(handle, "property", "index")</pre>
-''<span style="color:red;">No additional examples</span>''

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation