API Component.Property.CopyFilter
From Flowcode Help
Jump to navigationJump to search
<sidebar>API contents</sidebar>
Copies a property filter from one target to another
Contents
Parameters
HANDLE Source
- The source component to copy from
HANDLE Dest
- The target component to copy to
STRING Property
- The textual name of the property
Return value
The text copied from Source to Dest.
Detailed description
This copies a properties filter for the named Property from the Source component to the Dest. It is provided for convenience.
An equivalent call using SetFilter from this to a dest component may be:
- ::Component.Property.SetFilter(dest, "property", this::property)
And from any component to another:
- value = ::Component.Property.GetFilter(source, "property")
- ::Component.Property.SetFilter(dest, "property", value)
Examples
Calling in a calculation
- Declare a variable 'result' of type STRING
- Add to a calculation icon:
result = ::Component.Property.CopyFilter(source, dest, "property")
No additional examples