API Component.Property.AddListItem: Difference between revisions
XML import API auto-gen |
XML import |
||
| Line 2: | Line 2: | ||
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=== | |||
:Component | |||
::Property | |||
:::AddListItem | |||
</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.AddListItem(handle, "property", "index", "value")</pre> | ||
Revision as of 15:28, 11 May 2013
<sidebar>API contents</sidebar> Alters or appends a list entries text for the property by named index
Class hierarchy
- Component
- Property
- AddListItem
- Property
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.AddListItem(handle, "property", "index", "value")