Difference between revisions of "API Component.Property.GetFilter"
From Flowcode Help
Jump to navigationJump to search (XML Import to change Variable types into Variable Types) |
|||
(5 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | |
− | Gets a components property filter string for lists, files, etc | + | |- |
+ | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
+ | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetFilter''' | ||
+ | |- | ||
+ | | colspan="2" | Gets a components property filter string for lists, files, etc | ||
+ | |- | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | ||
+ | | width="90%" | Handle | ||
+ | |- | ||
+ | | colspan="2" | The component handle of the property owner | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | ||
+ | | width="90%" | Property | ||
+ | |- | ||
+ | | colspan="2" | The textual name of the property | ||
+ | |- | ||
+ | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING | ||
+ | | width="90%" style="border-top: 2px solid #000;" | ''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 Type|property types]] for further details. | |
− | |||
− | |||
− | |||
− | |||
Line 32: | Line 33: | ||
* Declare a variable 'result' of type STRING | * Declare a variable 'result' of type STRING | ||
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.Property.GetFilter(handle, "property")</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.Property.GetFilter(handle, "property")</pre> | ||
− | |||
− |
Latest revision as of 11:54, 16 January 2023
![]() |
GetFilter |
Gets a components property filter string for lists, files, etc | |
![]() |
Handle |
The component handle of the property owner | |
![]() |
Property |
The textual name of the property | |
![]() |
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")