API Panel.Position.GetBox

From Flowcode Help
Revision as of 15:57, 16 January 2014 by JonnyW (talk | contribs) (XML import)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search

<sidebar>API Contents</sidebar> Gets a handle to an object representing the components bounding box position

Class hierarchy

Panel

Position
GetBox

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 bounding box position


Detailed description

This call gets the objects bounding box position. This can be thought of as the objects size rather than its raw scale value.


The difference between scale and size only applies to objects with child objects, such as groups or compiled components.

Scale and size of the box


Examples

Calling in a calculation

  • Declare a variable 'result' of type HANDLE
  • Add to a calculation icon:
    result = ::Panel.Position.GetBox(handle)

No additional examples