Jump to content

API Component.Property.GetFilter

From Flowcode Help
Revision as of 14:11, 13 July 2026 by SteveT (talk | contribs) (Text replacement - "width="90%" style="background-color:#D8C9D8; color:#4B008D;"" to "width="90%" class="mtx-class-macrohead"")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
GetFilter
Gets a components property filter string for lists, files, etc 
- HANDLE Handle
The component handle of the property owner 
- STRING Property
The textual name of the property 
- 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")