Difference between revisions of "API Component.Property.SetChildValues"

From Flowcode Help
Jump to navigationJump to search
 
Line 37: Line 37:
 
===Calling in a calculation===
 
===Calling in a calculation===
 
* 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 examples</span>''
 

Latest revision as of 11:54, 16 January 2023

Fc9-comp-macro.png SetChildValues
Sets all child components property as a string 
Fc9-h32-icon.png - HANDLE Parent
The owning component whose children will all be written to 
Fc9-string-icon.png - STRING Property
The textual name of the property 
Fc9-string-icon.png - STRING Value
The value to update the properties text with 
Fc9-void-icon.png - NONE Return


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")