API Component.Property.AddListItem: Difference between revisions
XML import API changes |
XML Import to change Variable types into Variable Types |
||
| Line 11: | Line 11: | ||
==Parameters== | ==Parameters== | ||
[[Variable | [[Variable Types|HANDLE]] ''Handle'' | ||
:The component handle to alter the property of | :The component handle to alter the property of | ||
[[Variable | [[Variable Types|STRING]] ''Property'' | ||
:The textual name of the property | :The textual name of the property | ||
[[Variable | [[Variable Types|STRING]] ''Index'' | ||
:The text or integer entry of the property | :The text or integer entry of the property | ||
[[Variable | [[Variable Types|STRING]] ''Value'' | ||
:The value to update the entry with | :The value to update the entry with | ||
==Return value== | ==Return value== | ||
[[Variable | [[Variable Types|BOOL]] | ||
Returns true if the operation is a success, else false | Returns true if the operation is a success, else false | ||
Revision as of 11:08, 10 June 2013
<sidebar>API contents</sidebar> Alters or appends a list entries text for the property by named index
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
No additional information
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 information