Difference between revisions of "API Component.Property.SetListItem"

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import)
Line 3: Line 3:
  
 
<div style="width:25%; float:right" class="toc">
 
<div style="width:25%; float:right" class="toc">
===Class hierarchy===[[API Component|Component]]
+
====Class hierarchy====
 +
[[API Component|Component]]
 
:[[API Component.Property|Property]]
 
:[[API Component.Property|Property]]
 
::[[API Component.Property|SetListItem]]
 
::[[API Component.Property|SetListItem]]
Line 10: Line 11:
  
 
==Parameters==
 
==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
  
''[[Variable types|STRING]] Property''
+
[[Variable types|STRING]] ''Property''
 
:The textual name of the property
 
:The textual name of the property
  
''[[Variable types|STRING]] Index''
+
[[Variable types|STRING]] ''Index''
 
:The text or integer entry of the property
 
:The text or integer entry of the property
  
''[[Variable types|STRING]] Value''
+
[[Variable types|STRING]] ''Value''
 
:The value to update the entry with
 
:The value to update the entry with
  
Line 25: Line 26:
 
[[Variable types|BOOL]]
 
[[Variable types|BOOL]]
  
No additional information
+
''<span style="color:red;">No additional information</span>''
 +
 
 +
 
  
 
==Detailed description==
 
==Detailed description==
''No additional information''
+
''<span style="color:red;">No additional information</span>''
 +
 
  
 
==Examples==
 
==Examples==
Line 34: Line 38:
 
* Declare a variable 'result' of type BOOL
 
* Declare a variable 'result' of type BOOL
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.Property.SetListItem(handle, "property", "index", "value")</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.Property.SetListItem(handle, "property", "index", "value")</pre>
 +
 +
''<span style="color:red;">No additional information</span>''

Revision as of 22:07, 11 May 2013

<sidebar>API contents</sidebar> Sets an existing list entries text for the property by named index

Class hierarchy

Component

Property
SetListItem

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

BOOL

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")

No additional information