Difference between revisions of "API Component.Clone"

From Flowcode Help
Jump to navigationJump to search
(XML Import to change Variable types into Variable Types)
(XML import of updated API docs)
Line 1: Line 1:
 +
 +
 
<sidebar>API contents</sidebar>
 
<sidebar>API contents</sidebar>
 
Clones an existing object to another position on the panel
 
Clones an existing object to another position on the panel
Line 38: Line 40:
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.Clone(source, destparent, newposition)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.Clone(source, destparent, newposition)</pre>
  
''<span style="color:red;">No additional information</span>''
+
''<span style="color:red;">No additional examples</span>''

Revision as of 09:58, 17 June 2013


<sidebar>API contents</sidebar> Clones an existing object to another position on the panel

Class hierarchy

Component

Clone

Parameters

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


Return value

HANDLE

A handle to the newly created component, 0 if the call failed.


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)

No additional examples