Difference between revisions of "API Component.Property.AddListItem"
From Flowcode Help
Jump to navigationJump to search (XML import API auto-gen) |
(XML import) |
||
| (12 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Alters or appends a list entries text for the property by named index | Alters or appends a list entries text for the property by named index | ||
| + | <div style="width:25%; float:right" class="toc"> | ||
| + | ====Class hierarchy==== | ||
| + | [[API Component|Component]] | ||
| + | :[[API Component.Property|Property]] | ||
| + | ::[[API Component.Property|AddListItem]] | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
| − | + | [[Variable Types|HANDLE]] ''Handle'' | |
:The component handle to alter the property of | :The component handle to alter the property of | ||
| − | + | [[Variable Types|STRING]] ''Property'' | |
:The textual name of the property | :The textual name of the property | ||
| − | + | [[Variable Types|STRING]] ''Index'' | |
:The text or integer entry of the property | :The text or integer entry of the property | ||
| − | + | [[Variable Types|STRING]] ''Value'' | |
:The value to update the entry with | :The value to update the entry with | ||
| − | |||
| − | |||
| − | + | ==Return value== | |
| + | [[Variable Types|BOOL]] | ||
| − | + | Returns true if the operation is a success, else false | |
| − | |||
| − | ===Examples | + | |
| − | + | ==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 | * Declare a variable 'result' of type BOOL | ||
| − | * Add to a calculation icon: <pre class="brush:[ | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.Property.AddListItem(handle, "property", "index", "value")</pre> |
| + | |||
| + | ''<span style="color:red;">No additional examples</span>'' | ||
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Alters or appends a list entries text for the property by named index
Contents
Parameters
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
Return value
Returns true if the operation is a success, else false
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")
No additional examples
