Difference between revisions of "API Component.Property.GetFilter"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
(7 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Gets a components property filter string for lists, files, etc | Gets a components property filter string for lists, files, etc | ||
Line 11: | Line 11: | ||
==Parameters== | ==Parameters== | ||
− | [[Variable | + | [[Variable Types|HANDLE]] ''Handle'' |
:The component handle of the property owner | :The component handle of the property owner | ||
− | [[Variable | + | [[Variable Types|STRING]] ''Property'' |
:The textual name of the property | :The textual name of the property | ||
+ | |||
==Return value== | ==Return value== | ||
− | [[Variable | + | [[Variable Types|STRING]] |
Returns the components property filter string for lists, files, etc | Returns the components property filter string for lists, files, etc | ||
+ | |||
==Detailed description== | ==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 31: | Line 36: | ||
* 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> | ||
− | ''<span style="color:red;">No additional | + | ''<span style="color:red;">No additional examples</span>'' |
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Gets a components property filter string for lists, files, etc
Contents
Parameters
HANDLE Handle
- The component handle of the property owner
STRING Property
- The textual name of the property
Return value
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 examples