API Component.GetOriginal: Difference between revisions
No edit summary |
m Text replacement - "width="90%" style="background-color:#D8C9D8; color:#4B008D;"" to "width="90%" class="mtx-class-macrohead"" |
||
| (8 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{| 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 | ||
|- | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | |||
| width="90%" | Current | |||
= | |- | ||
| colspan="2" | The component to find the definition of | |||
|- | |||
| 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'' | |||
== | |} | ||
[[ | |||
| Line 34: | Line 31: | ||
* Declare a variable 'result' of type HANDLE | * Declare a variable 'result' of type HANDLE | ||
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.GetOriginal(current)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.GetOriginal(current)</pre> | ||
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)