API Component.Property.SetChildValues: Difference between revisions

Latest revision as of 14:11, 13 July 2026

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

@@ Line 1: / Line 1: @@
+{| class="mtx-class-macrotable wikitable"
+|-
-<sidebar>API contents</sidebar>
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-Sets all child components property as a string
+| width="90%" class="mtx-class-macrohead" | '''SetChildValues'''
+|-
-<div style="width:25%; float:right" class="toc">
+| colspan="2" | Sets all child components property as a string&nbsp;
-====Class hierarchy====
+|-
-[[API Component|Component]]
+|-
-:[[API Component.Property|Property]]
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
-::[[API Component.Property|SetChildValues]]
+| width="90%" | Parent
-</div>
+|-
-__TOC__
+| colspan="2" | The owning component whose children will all be written to&nbsp;
+|-
-==Parameters==
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
-[[Variable Types|HANDLE]] ''Parent''
+| width="90%" | Property
-:The owning component whose children will all be written to
+|-
+| colspan="2" | The textual name of the property&nbsp;
-[[Variable Types|STRING]] ''Property''
+|-
-:The textual name of the property
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | Value
-[[Variable Types|STRING]] ''Value''
+|-
-:The value to update the properties text with
+| colspan="2" | The value to update the properties text with&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE
-==Return value==
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
-''This call does not return a value''
+|}
@@ Line 37: / Line 37: @@
 ===Calling in a calculation===
 * Add to a calculation icon: <pre class="brush:[cpp]">::Component.Property.SetChildValues(parent, "property", "value")</pre>
-''<span style="color:red;">No additional examples</span>''

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation