Difference between revisions of "API Component.Property.SetChildValues"
From Flowcode Help
Jump to navigationJump to search (XML Import to change Variable types into Variable Types) |
(XML import of updated API docs) |
||
| Line 1: | Line 1: | ||
| + | |||
| + | |||
<sidebar>API contents</sidebar> | <sidebar>API contents</sidebar> | ||
Sets all child components property as a string | Sets all child components property as a string | ||
| Line 36: | Line 38: | ||
* Add to a calculation icon: <pre class="brush:[cpp]">::Component.Property.SetChildValues(parent, "property", "value")</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">::Component.Property.SetChildValues(parent, "property", "value")</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>
Sets all child components property as a string
Contents
Parameters
HANDLE Parent
- The owning component whose children will all be written to
STRING Property
- The textual name of the property
STRING Value
- The value to update the properties text with
Return value
This call does not return a value
Detailed description
This call steps through all the children of the component and sets the property specified in each to the given value. It is useful for updating a property in all the children of a group, for example.
Note this does not step through the children of compiled components, only those 'owned' by the Parent.
Examples
Calling in a calculation
- Add to a calculation icon:
::Component.Property.SetChildValues(parent, "property", "value")
No additional examples
