Difference between revisions of "API Component.Property"
From Flowcode Help
Jump to navigationJump to search (XML import API auto-gen) |
(XML import) |
||
(17 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | + | <sidebar>API Contents</sidebar> | |
Property manipulation functions | Property manipulation functions | ||
− | + | This class is contained within [[API Component|Component]]. | |
− | |||
− | ===Examples=== | + | __TOC__ |
+ | |||
+ | ==Functions provided for this class== | ||
+ | {| | ||
+ | |- | ||
+ | |width="35%"|[[API Component.Property.GetValue|GetValue]] | ||
+ | |Gets the value of a property as a string | ||
+ | |- | ||
+ | |width="35%"|[[API Component.Property.SetColor|SetColor]] | ||
+ | |Sets a components 'color' property as a R,G,B value | ||
+ | |- | ||
+ | |width="35%"|[[API Component.Property.SetValue|SetValue]] | ||
+ | |Sets a components property as a string | ||
+ | |- | ||
+ | |width="35%"|[[API Component.Property.CopyValue|CopyValue]] | ||
+ | |Copies a property value from one target to another | ||
+ | |- | ||
+ | |width="35%"|[[API Component.Property.SetChildValues|SetChildValues]] | ||
+ | |Sets all child components property as a string | ||
+ | |- | ||
+ | |width="35%"|[[API Component.Property.CopyChildValues|CopyChildValues]] | ||
+ | |Copies the values of a properties children from the source to dest | ||
+ | |- | ||
+ | |width="35%"|[[API Component.Property.SetVisible|SetVisible]] | ||
+ | |Sets whether the property is visible or not | ||
+ | |- | ||
+ | |width="35%"|[[API Component.Property.SetWritable|SetWritable]] | ||
+ | |Sets whether the property can be edited in the UI or not | ||
+ | |- | ||
+ | |width="35%"|[[API Component.Property.GetVisible|GetVisible]] | ||
+ | |Gets whether the property is visible or not | ||
+ | |- | ||
+ | |width="35%"|[[API Component.Property.GetWritable|GetWritable]] | ||
+ | |Gets whether the property can be edited in the UI or not | ||
+ | |- | ||
+ | |width="35%"|[[API Component.Property.GetFilter|GetFilter]] | ||
+ | |Gets a components property filter string for lists, files, etc | ||
+ | |- | ||
+ | |width="35%"|[[API Component.Property.SetFilter|SetFilter]] | ||
+ | |Sets a components property filter string for lists, files, etc | ||
+ | |- | ||
+ | |width="35%"|[[API Component.Property.CopyFilter|CopyFilter]] | ||
+ | |Copies a property filter from one target to another | ||
+ | |- | ||
+ | |width="35%"|[[API Component.Property.GetListIndex|GetListIndex]] | ||
+ | |Gets a single lists index value from a property by line number | ||
+ | |- | ||
+ | |width="35%"|[[API Component.Property.GetListItem|GetListItem]] | ||
+ | |Gets a single list entry from a property by named index | ||
+ | |- | ||
+ | |width="35%"|[[API Component.Property.SetListItem|SetListItem]] | ||
+ | |Sets an existing list entries text for the property by named index | ||
+ | |- | ||
+ | |width="35%"|[[API Component.Property.AddListItem|AddListItem]] | ||
+ | |Alters or appends a list entries text for the property by named index | ||
+ | |} | ||
+ | |||
+ | |||
+ | ==Examples== | ||
+ | ''<span style="color:red;">No additional examples</span>'' | ||
+ | |||
+ | ==See also== | ||
+ | ''<span style="color:red;">No additional information</span>'' |
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Property manipulation functions
This class is contained within Component.
Functions provided for this class
GetValue | Gets the value of a property as a string |
SetColor | Sets a components 'color' property as a R,G,B value |
SetValue | Sets a components property as a string |
CopyValue | Copies a property value from one target to another |
SetChildValues | Sets all child components property as a string |
CopyChildValues | Copies the values of a properties children from the source to dest |
SetVisible | Sets whether the property is visible or not |
SetWritable | Sets whether the property can be edited in the UI or not |
GetVisible | Gets whether the property is visible or not |
GetWritable | Gets whether the property can be edited in the UI or not |
GetFilter | Gets a components property filter string for lists, files, etc |
SetFilter | Sets a components property filter string for lists, files, etc |
CopyFilter | Copies a property filter from one target to another |
GetListIndex | Gets a single lists index value from a property by line number |
GetListItem | Gets a single list entry from a property by named index |
SetListItem | Sets an existing list entries text for the property by named index |
AddListItem | Alters or appends a list entries text for the property by named index |
Examples
No additional examples
See also
No additional information