Difference between revisions of "API Component.Property.GetFilter"
From Flowcode Help
Jump to navigationJump to search (XML import of updated API docs) |
|||
| Line 1: | Line 1: | ||
| + | |||
| + | |||
<sidebar>API contents</sidebar> | <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 36: | Line 38: | ||
* 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>'' |
Revision as of 09:58, 17 June 2013
<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
