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

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|GetFilter]]
 
::[[API Component.Property|GetFilter]]
Line 10: Line 11:
  
 
==Parameters==
 
==Parameters==
''[[Variable types|HANDLE]] Handle''
+
[[Variable types|HANDLE]] ''Handle''
 
:The component handle of the property owner
 
:The component handle of the property owner
  
''[[Variable types|STRING]] Property''
+
[[Variable types|STRING]] ''Property''
 
:The textual name of the property
 
:The textual name of the property
  
Line 22: Line 23:
  
 
==Detailed description==
 
==Detailed description==
''No additional information''
+
''<span style="color:red;">No additional information</span>''
 +
 
  
 
==Examples==
 
==Examples==
Line 28: Line 30:
 
* Declare a variable 'result' of type STRING
 
* Declare a variable 'result' of type STRING
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.Property.GetFilter(handle, "property")</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.Property.GetFilter(handle, "property")</pre>
 +
 +
''<span style="color:red;">No additional information</span>''

Revision as of 22:07, 11 May 2013

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

Class hierarchy

Component

Property
GetFilter

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

No additional information