API Component.Property.CopyChildValues: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	CopyChildValues
Copies the values of a properties children from the source to dest
- HANDLE	Source
The source component to copy from
- HANDLE	Dest
The target component to copy to
- STRING	Property
The textual name of the property to act as root
- NONE	Return

Detailed description

Examples

Calling in a calculation

Add to a calculation icon:

::Component.Property.CopyChildValues(source, dest, "property")

@@ Line 1: / Line 1: @@
-<sidebar>API Contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Copies the values of a properties children from the source to dest
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''CopyChildValues'''
+|-
+| colspan="2" | Copies the values of a properties children from the source to dest&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Source
+|-
+| colspan="2" | The source component to copy from&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Dest
+|-
+| colspan="2" | The target component to copy to&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | Property
+|-
+| colspan="2" | The textual name of the property to act as root&nbsp;
+|-
+| 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''
+|}
-<div style="width:25%; float:right" class="toc">
-====Class hierarchy====
-[[API Component|Component]]
-:[[API Component.Property|Property]]
-::[[API Component.Property|CopyChildValues]]
-</div>
-__TOC__
-==Parameters==
-[[Variable Types|HANDLE]] ''Source''
-:The source component to copy from
-[[Variable Types|HANDLE]] ''Dest''
-:The target component to copy to
-[[Variable Types|STRING]] ''Property''
-:The textual name of the property to act as root
-==Return value==
-''This call does not return a value''
+==Detailed description==
-==Detailed description==
-''<span style="color:red;">No additional information</span>''
@@ Line 32: / Line 34: @@
 ===Calling in a calculation===
 * Add to a calculation icon: <pre class="brush:[cpp]">::Component.Property.CopyChildValues(source, dest, "property")</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