API Component.Property.GetFilter

From Flowcode Help
Jump to navigationJump to search
Fc9-comp-macro.png GetFilter
Gets a components property filter string for lists, files, etc 
Fc9-h32-icon.png - HANDLE Handle
The component handle of the property owner 
Fc9-string-icon.png - STRING Property
The textual name of the property 
Fc9-string-icon.png - STRING Return


Detailed description

Gets the filter field of a property. The filter field is a text block whose use in Flowcode is decided by the properties type.


The field, for example, may be used to hold a list of items in a list-type property, or a file-filter in a file selection property. See the list of property types for further details.


Examples

Calling in a calculation

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