View source for API Component.Property.AddListItem

{| class="mtx-class-macrotable wikitable"
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''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''
|}


==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 [[API Component.Property.GetListIndex|GetListIndex]].


To add the line to the list only if it exists, use [[API Component.Property.SetListItem|SetListItem]].



==Examples==
===Calling in a calculation===
* 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>