Difference between revisions of "API Component.Property"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
| Line 5: | Line 5: | ||
{| | {| | ||
|- | |- | ||
| − | |[[API Component.Property.GetValue|GetValue]] | + | |width="35%"|[[API Component.Property.GetValue|GetValue]] |
|Gets the value of a property as a string | |Gets the value of a property as a string | ||
|- | |- | ||
| − | |[[API Component.Property.SetColor|SetColor]] | + | |width="35%"|[[API Component.Property.SetColor|SetColor]] |
|Sets a components 'color' property as a R,G,B value | |Sets a components 'color' property as a R,G,B value | ||
|- | |- | ||
| − | |[[API Component.Property.SetValue|SetValue]] | + | |width="35%"|[[API Component.Property.SetValue|SetValue]] |
|Sets a components property as a string | |Sets a components property as a string | ||
|- | |- | ||
| − | |[[API Component.Property.CopyValue|CopyValue]] | + | |width="35%"|[[API Component.Property.CopyValue|CopyValue]] |
|Copies a property value from one target to another | |Copies a property value from one target to another | ||
|- | |- | ||
| − | |[[API Component.Property.SetChildValues|SetChildValues]] | + | |width="35%"|[[API Component.Property.SetChildValues|SetChildValues]] |
|Sets all child components property as a string | |Sets all child components property as a string | ||
|- | |- | ||
| − | |[[API Component.Property.SetVisible|SetVisible]] | + | |width="35%"|[[API Component.Property.SetVisible|SetVisible]] |
|Sets whether the property is visible or not | |Sets whether the property is visible or not | ||
|- | |- | ||
| − | |[[API Component.Property.SetWritable|SetWritable]] | + | |width="35%"|[[API Component.Property.SetWritable|SetWritable]] |
|Sets whether the property can be edited in the UI or not | |Sets whether the property can be edited in the UI or not | ||
|- | |- | ||
| − | |[[API Component.Property.GetVisible|GetVisible]] | + | |width="35%"|[[API Component.Property.GetVisible|GetVisible]] |
|Gets whether the property is visible or not | |Gets whether the property is visible or not | ||
|- | |- | ||
| − | |[[API Component.Property.GetWritable|GetWritable]] | + | |width="35%"|[[API Component.Property.GetWritable|GetWritable]] |
|Gets whether the property can be edited in the UI or not | |Gets whether the property can be edited in the UI or not | ||
|- | |- | ||
| − | |[[API Component.Property.GetFilter|GetFilter]] | + | |width="35%"|[[API Component.Property.GetFilter|GetFilter]] |
|Gets a components property filter string for lists, files, etc | |Gets a components property filter string for lists, files, etc | ||
|- | |- | ||
| − | |[[API Component.Property.SetFilter|SetFilter]] | + | |width="35%"|[[API Component.Property.SetFilter|SetFilter]] |
|Sets a components property filter string for lists, files, etc | |Sets a components property filter string for lists, files, etc | ||
|- | |- | ||
| − | |[[API Component.Property.CopyFilter|CopyFilter]] | + | |width="35%"|[[API Component.Property.CopyFilter|CopyFilter]] |
|Copies a property filter from one target to another | |Copies a property filter from one target to another | ||
|- | |- | ||
| − | |[[API Component.Property.GetListIndex|GetListIndex]] | + | |width="35%"|[[API Component.Property.GetListIndex|GetListIndex]] |
|Gets a single lists index value from a property by line number | |Gets a single lists index value from a property by line number | ||
|- | |- | ||
| − | |[[API Component.Property.GetListItem|GetListItem]] | + | |width="35%"|[[API Component.Property.GetListItem|GetListItem]] |
|Gets a single list entry from a property by named index | |Gets a single list entry from a property by named index | ||
|- | |- | ||
| − | |[[API Component.Property.SetListItem|SetListItem]] | + | |width="35%"|[[API Component.Property.SetListItem|SetListItem]] |
|Sets an existing list entries text for the property by named index | |Sets an existing list entries text for the property by named index | ||
|- | |- | ||
| − | |[[API Component.Property.AddListItem|AddListItem]] | + | |width="35%"|[[API Component.Property.AddListItem|AddListItem]] |
|Alters or appends a list entries text for the property by named index | |Alters or appends a list entries text for the property by named index | ||
| + | |} | ||
| − | |||
==Functions provided for this class== | ==Functions provided for this class== | ||
{| | {| | ||
|- | |- | ||
| − | |[[API Component.Property.GetValue|GetValue]] | + | |width="35%"|[[API Component.Property.GetValue|GetValue]] |
|Gets the value of a property as a string | |Gets the value of a property as a string | ||
|- | |- | ||
| − | |[[API Component.Property.SetColor|SetColor]] | + | |width="35%"|[[API Component.Property.SetColor|SetColor]] |
|Sets a components 'color' property as a R,G,B value | |Sets a components 'color' property as a R,G,B value | ||
|- | |- | ||
| − | |[[API Component.Property.SetValue|SetValue]] | + | |width="35%"|[[API Component.Property.SetValue|SetValue]] |
|Sets a components property as a string | |Sets a components property as a string | ||
|- | |- | ||
| − | |[[API Component.Property.CopyValue|CopyValue]] | + | |width="35%"|[[API Component.Property.CopyValue|CopyValue]] |
|Copies a property value from one target to another | |Copies a property value from one target to another | ||
|- | |- | ||
| − | |[[API Component.Property.SetChildValues|SetChildValues]] | + | |width="35%"|[[API Component.Property.SetChildValues|SetChildValues]] |
|Sets all child components property as a string | |Sets all child components property as a string | ||
|- | |- | ||
| − | |[[API Component.Property.SetVisible|SetVisible]] | + | |width="35%"|[[API Component.Property.SetVisible|SetVisible]] |
|Sets whether the property is visible or not | |Sets whether the property is visible or not | ||
|- | |- | ||
| − | |[[API Component.Property.SetWritable|SetWritable]] | + | |width="35%"|[[API Component.Property.SetWritable|SetWritable]] |
|Sets whether the property can be edited in the UI or not | |Sets whether the property can be edited in the UI or not | ||
|- | |- | ||
| − | |[[API Component.Property.GetVisible|GetVisible]] | + | |width="35%"|[[API Component.Property.GetVisible|GetVisible]] |
|Gets whether the property is visible or not | |Gets whether the property is visible or not | ||
|- | |- | ||
| − | |[[API Component.Property.GetWritable|GetWritable]] | + | |width="35%"|[[API Component.Property.GetWritable|GetWritable]] |
|Gets whether the property can be edited in the UI or not | |Gets whether the property can be edited in the UI or not | ||
|- | |- | ||
| − | |[[API Component.Property.GetFilter|GetFilter]] | + | |width="35%"|[[API Component.Property.GetFilter|GetFilter]] |
|Gets a components property filter string for lists, files, etc | |Gets a components property filter string for lists, files, etc | ||
|- | |- | ||
| − | |[[API Component.Property.SetFilter|SetFilter]] | + | |width="35%"|[[API Component.Property.SetFilter|SetFilter]] |
|Sets a components property filter string for lists, files, etc | |Sets a components property filter string for lists, files, etc | ||
|- | |- | ||
| − | |[[API Component.Property.CopyFilter|CopyFilter]] | + | |width="35%"|[[API Component.Property.CopyFilter|CopyFilter]] |
|Copies a property filter from one target to another | |Copies a property filter from one target to another | ||
|- | |- | ||
| − | |[[API Component.Property.GetListIndex|GetListIndex]] | + | |width="35%"|[[API Component.Property.GetListIndex|GetListIndex]] |
|Gets a single lists index value from a property by line number | |Gets a single lists index value from a property by line number | ||
|- | |- | ||
| − | |[[API Component.Property.GetListItem|GetListItem]] | + | |width="35%"|[[API Component.Property.GetListItem|GetListItem]] |
|Gets a single list entry from a property by named index | |Gets a single list entry from a property by named index | ||
|- | |- | ||
| − | |[[API Component.Property.SetListItem|SetListItem]] | + | |width="35%"|[[API Component.Property.SetListItem|SetListItem]] |
|Sets an existing list entries text for the property by named index | |Sets an existing list entries text for the property by named index | ||
|- | |- | ||
| − | |[[API Component.Property.AddListItem|AddListItem]] | + | |width="35%"|[[API Component.Property.AddListItem|AddListItem]] |
|Alters or appends a list entries text for the property by named index | |Alters or appends a list entries text for the property by named index | ||
| + | |} | ||
| − | |||
==Examples== | ==Examples== | ||
| + | ''No examples available'' | ||
Revision as of 13:47, 11 May 2013
<sidebar>API contents</sidebar> Property manipulation functions
Sub-classes 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 |
| 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 |
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 |
| 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 examples available
