Difference between revisions of "API Component.Property.SetListItem"
From Flowcode Help
Jump to navigationJump to search (XML import API auto-gen) |
|||
| (23 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | |
| − | Sets an existing list entries text for the property by named index | + | |- |
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetListItem''' | ||
| + | |- | ||
| + | | colspan="2" | Sets an existing list entries text for the property by named index | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | ||
| + | | width="90%" | Handle | ||
| + | |- | ||
| + | | colspan="2" | The component handle to alter 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" | [[File:Fc9-string-icon.png]] - STRING | ||
| + | | width="90%" | Value | ||
| + | |- | ||
| + | | colspan="2" | The value to update the entry with | ||
| + | |- | ||
| + | | 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 this call fails. |
| − | |||
| − | |||
| − | |||
| − | '' | + | 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 regardless of whether it exists, use [[API Component.Property.AddListItem|AddListItem]]. | |
| − | |||
| − | + | ==Examples== | |
| − | + | ===Calling in a calculation=== | |
* Declare a variable 'result' of type BOOL | * Declare a variable 'result' of type BOOL | ||
| − | * Add to a calculation icon: result = ::Component.Property.SetListItem(handle, "property", "index", "value") | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.Property.SetListItem(handle, "property", "index", "value")</pre> |
Latest revision as of 11:54, 16 January 2023
|
SetListItem |
| Sets an existing 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 this call fails.
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 regardless of whether it exists, use AddListItem.
Examples
Calling in a calculation
- Declare a variable 'result' of type BOOL
- Add to a calculation icon:
result = ::Component.Property.SetListItem(handle, "property", "index", "value")
