Difference between revisions of "API Component.Property.GetFilter"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
(XML import) |
||
| (20 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | <sidebar>API Contents</sidebar> | |
| − | + | Gets a components property filter string for lists, files, etc | |
| − | + | <div style="width:25%; float:right" class="toc"> | |
| − | + | ====Class hierarchy==== | |
| + | [[API Component|Component]] | ||
| + | :[[API Component.Property|Property]] | ||
| + | ::[[API Component.Property|GetFilter]] | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
| − | + | [[Variable Types|HANDLE]] ''Handle'' | |
:The component handle of the property owner | :The component handle of the property owner | ||
| − | + | [[Variable Types|STRING]] ''Property'' | |
:The textual name of the property | :The textual name of the property | ||
| − | + | ||
| − | [[Variable | + | ==Return value== |
| + | [[Variable Types|STRING]] | ||
Returns the components property filter string for lists, files, etc | Returns the components property filter string for lists, files, etc | ||
| − | |||
| − | |||
| − | ===Examples | + | ==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. | ||
| + | |||
| + | |||
| + | ==Examples== | ||
| + | ===Calling in a calculation=== | ||
* Declare a variable 'result' of type STRING | * Declare a variable 'result' of type STRING | ||
| − | * Add to a calculation icon: result = ::Component.Property.GetFilter(handle, "property") | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.Property.GetFilter(handle, "property")</pre> |
| + | |||
| + | ''<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
