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

From Flowcode Help
Jump to navigationJump to search
(XML import of updated API docs)
(XML import of API documentation)
Line 1: Line 1:
  
  
<sidebar>API contents</sidebar>
+
<sidebar>API Contents</sidebar>
 
Gets a handle to an object representing the components bounding box position
 
Gets a handle to an object representing the components bounding box position
  

Revision as of 14:27, 9 August 2013


<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