API Component.Property.GetFilter

<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

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

No additional information