API Component.GetOriginal

From Flowcode Help
Jump to: navigation, search

Gets the original definition of the component, returns Current if no original copy

Class hierarchy

Component

GetOriginal

Contents


Parameters

HANDLE Current

The component to find the definition of


Return value

HANDLE

Returns the original definition of the component, returns Current if no original copy


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)

No additional examples

Personal tools