API Component.Property.AddListItem: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	AddListItem
Alters or appends a list entries text for the property by named index
- HANDLE	Handle
The component handle to alter the property of
- STRING	Property
The textual name of the property
- STRING	Index
The text or integer entry of the property
- STRING	Value
The value to update the entry with
- BOOL	Return

Detailed description

Sets the text part of a list property identified by its 3-digit Index'. If the line does not exist then a new line is appended to the list.

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.

To add the line to the list only if it exists, use SetListItem.

Examples

Calling in a calculation

Declare a variable 'result' of type BOOL

Add to a calculation icon:

result = ::Component.Property.AddListItem(handle, "property", "index", "value")

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Alters or appends a list entries text for the property by named index
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''AddListItem'''
+|-
+| colspan="2" | Alters or appends a list entries text for the property by named index&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Handle
+|-
+| colspan="2" | The component handle to alter the property of&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | Property
+|-
+| colspan="2" | The textual name of the property&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | Index
+|-
+| colspan="2" | The text or integer entry of the property&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | Value
+|-
+| colspan="2" | The value to update the entry with&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-<div style="width:25%; float:right" class="toc">
-====Class hierarchy====
-[[API Component|Component]]
-:[[API Component.Property|Property]]
-::[[API Component.Property|AddListItem]]
-</div>
-__TOC__
-==Parameters==
+==Detailed description==
-[[Variable types|HANDLE]] ''Handle''
+Sets the text part of a list property identified by its 3-digit ''Index'. If the line does not exist then a new line is appended to the list.
-:The component handle to alter the property of
-[[Variable types|STRING]] ''Property''
-:The textual name of the property
-[[Variable types|STRING]] ''Index''
-:The text or integer entry of the property
-[[Variable types|STRING]] ''Value''
+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.
-:The value to update the entry with
-==Return value==
+To find the index from the line, use [[API Component.Property.GetListIndex|GetListIndex]].
-[[Variable types|BOOL]]
-''<span style="color:red;">No additional information</span>''
+To add the line to the list only if it exists, use [[API Component.Property.SetListItem|SetListItem]].
-==Detailed description==
-''<span style="color:red;">No additional information</span>''
@@ Line 38: / Line 50: @@
 * Declare a variable 'result' of type BOOL
 * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.Property.AddListItem(handle, "property", "index", "value")</pre>
-''<span style="color:red;">No additional information</span>''

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation