API Panel.Position.Get

<sidebar>API contents</sidebar> Gets a handle to an object representing the components current position

Parameters

HANDLE Handle

The position or component to read from

The default value for this parameter is: this

Return value

HANDLE

Returns the handle to an object representing the components current position

Detailed description

Obtaining a handle to a component provides the ability to hold information about the position and coordinates of that component at the time the api is called. This has several uses for example tracking a position of an object prior to any changes to it's parameters. A good example how this is used can be seen by looking at the source code for the example provided in the API Panel.Position.Set wiki page.

Examples

Calling in a calculation

• Declare a variable 'result' of type HANDLE
• Add to a calculation icon:

  result = ::Panel.Position.Get(handle)