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

From Flowcode Help
Jump to navigationJump to search
(XML import)
(XML import API auto-gen)
Line 1: Line 1:
The start line of the article
+
<sidebar>API contents</sidebar>
==Component.PropertyGetListItem==
+
Gets a single list entry from a property by named index
  
Gets a single list entry from a property by named index
 
----
 
  
 
===Parameters===
 
===Parameters===
Line 24: Line 22:
  
 
===Examples===
 
===Examples===
====Calling in a calculation:====
+
====Calling in a calculation====
 
* Declare a variable 'result' of type STRING
 
* Declare a variable 'result' of type STRING
* Add to a calculation icon: result = ::Component.Property.GetListItem(handle, "property", "index")
+
* Add to a calculation icon: <pre class="brush:[C]">result = ::Component.Property.GetListItem(handle, "property", "index")</pre>

Revision as of 15:44, 10 May 2013

<sidebar>API contents</sidebar> Gets a single list entry from a property by named index


Parameters

HANDLE Handle

The component handle to get the property of

STRING Property

The textual name of the property

STRING Index

The text or integer entry of the property

Return value

STRING

Returns the single list entry from a property by named index

Detailed description

No additional information

Examples

Calling in a calculation

  • Declare a variable 'result' of type STRING
  • Add to a calculation icon:
    result = ::Component.Property.GetListItem(handle, "property", "index")