Difference between revisions of "API Component.Property.SetChildValues"
From Flowcode Help
Jump to navigationJump to search (XML import of updated API docs) |
|||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | |
| − | + | |- | |
| − | + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | |
| − | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetChildValues''' | |
| − | + | |- | |
| − | + | | colspan="2" | Sets all child components property as a string | |
| − | === | + | |- |
| − | [[ | + | |- |
| − | : | + | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE |
| − | :: | + | | width="90%" | Parent |
| − | + | |- | |
| − | + | | colspan="2" | The owning component whose children will all be written to | |
| − | + | |- | |
| − | == | + | | width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING |
| − | [[ | + | | width="90%" | Property |
| − | + | |- | |
| − | + | | colspan="2" | The textual name of the property | |
| − | [[ | + | |- |
| − | + | | width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | |
| − | + | | width="90%" | Value | |
| − | [[ | + | |- |
| − | + | | colspan="2" | The value to update the properties text with | |
| − | + | |- | |
| − | + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE | |
| − | == | + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' |
| − | '' | + | |} |
| 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> | ||
| − | |||
| − | |||
Latest revision as of 11:54, 16 January 2023
|
SetChildValues |
| Sets all child components property as a string | |
 - 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 | |
 - 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")
