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

From Flowcode Help
Jump to navigationJump to search
(XML import API changes)
(XML Import to change Variable types into Variable Types)
Line 11: 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
  
  
 
==Return value==
 
==Return value==
[[Variable types|STRING]]
+
[[Variable Types|STRING]]
  
 
Returns the components property filter string for lists, files, etc
 
Returns the components property filter string for lists, files, etc

Revision as of 11:08, 10 June 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