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

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.PropertyGetFilter==
+
Gets a components property filter string for lists, files, etc
  
Gets a components property filter string for lists, files, etc
 
----
 
  
 
===Parameters===
 
===Parameters===
Line 21: Line 19:
  
 
===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.GetFilter(handle, "property")
+
* Add to a calculation icon: <pre class="brush:[C]">result = ::Component.Property.GetFilter(handle, "property")</pre>

Revision as of 15:44, 10 May 2013

<sidebar>API contents</sidebar> Gets a components property filter string for lists, files, etc


Parameters

HANDLE Handle

The component handle of the property owner

STRING Property

The textual name of the property

Return value

STRING

Returns the components property filter string for lists, files, etc

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.GetFilter(handle, "property")