API Component.GetOriginal: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	GetOriginal
Gets the original definition of the component, returns Current if no original copy
- HANDLE	Current
The component to find the definition of
- HANDLE	Return

Detailed description

When a compiled component is loaded into Flowcode it is stored as a definition and a copy made, which is the actual component that is shown by the system. The original definition copy is used to create new instances of the loaded component.

This call retrieves a handle to that definition. It may not be deleted or re-linked but otherwise can be treated as any other component and its properties may be read or set.

Note that modifying the contents of this component or its children will affect subsequent copies added to the system, as they will be cloned from this template.

Examples

Calling in a calculation

Declare a variable 'result' of type HANDLE

Add to a calculation icon:

result = ::Component.GetOriginal(current)

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Gets the original definition of the component, returns Current if no original copy
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''GetOriginal'''
+|-
+| colspan="2" | Gets the original definition of the component, returns Current if no original copy&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Current
+|-
+| colspan="2" | The component to find the definition of&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-===Parameters===
+==Detailed description==
-''[[Variable types|HANDLE]] Current''
+When a compiled component is loaded into Flowcode it is stored as a ''definition'' and a copy made, which is the actual component that is shown by the system. The original definition copy is used to create new instances of the loaded component.
-:The component to find the definition of
-===Return value===
-[[Variable types|HANDLE]]
-Returns the original definition of the component, returns Current if no original copy
+This call retrieves a handle to that definition. It may not be deleted or re-linked but otherwise can be treated as any other component and its properties may be read or set.
-===Detailed description===
-''No additional information''
-===Examples===
+Note that modifying the contents of this component or its children will affect subsequent copies added to the system, as they will be cloned from this template.
-====Calling in a calculation====
+==Examples==
+===Calling in a calculation===
 * Declare a variable 'result' of type HANDLE
-* Add to a calculation icon: result = ::Component.GetOriginal(current)
+* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.GetOriginal(current)</pre>

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation