Difference between revisions of "API Component.Property.SetListItem"
From Flowcode Help
Jump to navigationJump to search (XML import API auto-gen) |
(XML import) |
||
| Line 2: | Line 2: | ||
Sets an existing list entries text for the property by named index | Sets an existing list entries text for the property by named index | ||
| + | <div style="width:25%; float:right" class="toc"> | ||
| + | ===Class hierarchy=== | ||
| + | :Component | ||
| + | ::Property | ||
| + | :::SetListItem | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
''[[Variable types|HANDLE]] Handle'' | ''[[Variable types|HANDLE]] Handle'' | ||
:The component handle to alter the property of | :The component handle to alter the property of | ||
| Line 16: | Line 23: | ||
:The value to update the entry with | :The value to update the entry with | ||
| − | + | ==Return value== | |
[[Variable types|BOOL]] | [[Variable types|BOOL]] | ||
No additional information | No additional information | ||
| − | + | ==Detailed description== | |
''No additional information'' | ''No additional information'' | ||
| − | + | ==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.SetListItem(handle, "property", "index", "value")</pre> |
Revision as of 15:28, 11 May 2013
<sidebar>API contents</sidebar> Sets an existing list entries text for the property by named index
Class hierarchy
- Component
- Property
- SetListItem
- Property
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
No additional information
Detailed description
No additional information
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")
