Jump to content

API Component.Property.SetListItem: Difference between revisions

From Flowcode Help
Admin (talk | contribs)
XML import API auto-gen test
Admin (talk | contribs)
XML import of API auto-gen
Line 1: Line 1:
wiki page name
<sidebar>API contents</sidebar>
==Component.PropertySetListItem==
Sets an existing list entries text for the property by named index


Sets an existing list entries text for the property by named index
----


===Parameters===
===Parameters===
Line 27: Line 25:


===Examples===
===Examples===
====Calling in a calculation:====
====Calling in a calculation====
* Declare a variable 'result' of type BOOL
* Declare a variable 'result' of type BOOL
* Add to a calculation icon: result = ::Component.Property.SetListItem(handle, "property", "index", "value")
* Add to a calculation icon: result = ::Component.Property.SetListItem(handle, "property", "index", "value")

Revision as of 15:35, 10 May 2013

<sidebar>API contents</sidebar> Sets an existing 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

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