Difference between revisions of "API Panel.Position.Set"

From Flowcode Help
Jump to navigationJump to search
(XML import of API documentation)
(XML import)
 
Line 1: Line 1:
 
 
 
<sidebar>API Contents</sidebar>
 
<sidebar>API Contents</sidebar>
 
Sets an objects position based on a component or pre-defined position
 
Sets an objects position based on a component or pre-defined position

Latest revision as of 15:57, 16 January 2014

<sidebar>API Contents</sidebar> Sets an objects position based on a component or pre-defined position

Class hierarchy

Panel

Position
Set

Parameters

HANDLE Dest

The position or component to update

HANDLE Source

The position or component to read from


Return value

BOOL

Returns true if the operation is a success, else false


Detailed description

This copies the entire contents of a position from Source to Dest. Either handle may be a position or component.

The position will be converted from the sources coordinate-space into the destination space when it is assigned. This means one unit in the Source space is equivalent to one unit in the Dest space, regardless of the scale of owning components.


Examples

Calling in a calculation

  • Declare a variable 'result' of type BOOL
  • Add to a calculation icon:
    result = ::Panel.Position.Set(dest, source)

No additional examples