API Component.Clone: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	Clone
Clones an existing object to another position on the panel
- HANDLE	Source
The object to copy
- HANDLE	DestParent
The parent to link the cloned object to
- HANDLE	NewPosition
A position to move the object to
- HANDLE	Return

Detailed description

This creates an identical copy of the object which may be inserted at any point in the component tree.

The root object may not be cloned, but other to that any object (even a definition) may be cloned.

Examples

Calling in a calculation

Declare a variable 'result' of type HANDLE

Add to a calculation icon:

result = ::Component.Clone(source, destparent, newposition)

@@ 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]]
-Clones an existing object to another position on the panel
+| width="90%" class="mtx-class-macrohead" | '''Clone'''
+|-
-<div style="width:25%; float:right" class="toc">
+| colspan="2" | Clones an existing object to another position on the panel&nbsp;
-====Class hierarchy====
+|-
-[[API Component|Component]]
+|-
-:[[API Component|Clone]]
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
-</div>
+| width="90%" | Source
-__TOC__
+|-
+| colspan="2" | The object to copy&nbsp;
-==Parameters==
+|-
-[[Variable Types|HANDLE]] ''Source''
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
-:The object to copy
+| width="90%" | DestParent
+|-
-[[Variable Types|HANDLE]] ''DestParent''
+| colspan="2" | The parent to link the cloned object to&nbsp;
-:The parent to link the cloned object to
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
-[[Variable Types|HANDLE]] ''NewPosition''
+| width="90%" | NewPosition
-:A position to move the object to
+|-
+| colspan="2" | A position to move the object to&nbsp;
+|-
-==Return value==
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
-[[Variable Types|HANDLE]]
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-A handle to the newly created component, 0 if the call failed.
@@ Line 39: / Line 38: @@
 * Declare a variable 'result' of type HANDLE
 * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.Clone(source, destparent, newposition)</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