Difference between revisions of "API Component.Property.SetFilter"
From Flowcode Help
Jump to navigationJump to search (XML import API auto-gen) |
(XML import) |
||
(16 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | API | + | <sidebar>API Contents</sidebar> |
Sets a components property filter string for lists, files, etc | Sets 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|SetFilter]] | ||
+ | </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 Types|STRING]] ''Value'' | |
:The value to update the property filter with | :The value to update the property filter with | ||
− | + | ||
+ | ==Return value== | ||
''This call does not return a value'' | ''This call does not return a value'' | ||
− | |||
− | |||
− | ===Examples | + | ==Detailed description== |
− | + | Sets the filter field of a property. The filter field is a text block whose use in Flowcode is decided by the properties type. | |
− | * Add to a calculation icon: ::Component.Property.SetFilter(handle, "property", "value") | + | |
+ | |||
+ | 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. | ||
+ | |||
+ | |||
+ | No checks are done for validation on the field, and any text desired may be entered into this. However, it is the callers responsibility to only add text with the correct format if a format is required.. | ||
+ | |||
+ | |||
+ | ==Examples== | ||
+ | ===Calling in a calculation=== | ||
+ | * Add to a calculation icon: <pre class="brush:[cpp]">::Component.Property.SetFilter(handle, "property", "value")</pre> | ||
+ | |||
+ | ''<span style="color:red;">No additional examples</span>'' |
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Sets 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
STRING Value
- The value to update the property filter with
Return value
This call does not return a value
Detailed description
Sets 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.
No checks are done for validation on the field, and any text desired may be entered into this. However, it is the callers responsibility to only add text with the correct format if a format is required..
Examples
Calling in a calculation
- Add to a calculation icon:
::Component.Property.SetFilter(handle, "property", "value")
No additional examples