API Panel.Position.GetBox: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	GetBox
Gets a handle to an object representing the components bounding box position
- HANDLE	Handle
The position or component to read from
- HANDLE	Return

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.

Add to a calculation icon:

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

@@ Line 1: / Line 1: @@
+{| class="mtx-class-macrotable wikitable"
+|-
-<sidebar>API Contents</sidebar>
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-Gets a handle to an object representing the components bounding box position
+| width="90%" class="mtx-class-macrohead" | '''GetBox'''
+|-
-<div style="width:25%; float:right" class="toc">
+| colspan="2" | Gets a handle to an object representing the components bounding box position&nbsp;
-====Class hierarchy====
+|-
-[[API Panel|Panel]]
+|-
-:[[API Panel.Position|Position]]
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
-::[[API Panel.Position|GetBox]]
+| width="90%" | Handle
-</div>
+|-
-__TOC__
+| colspan="2" | The position or component to read from&nbsp;
+|-
-==Parameters==
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
-[[Variable Types|HANDLE]] ''Handle''
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
-:The position or component to read from
+|}
-:''The default value for this parameter is: '''''this'''
-==Return value==
-[[Variable Types|HANDLE]]
-Returns the handle to an object representing the components bounding box position
@@ Line 39: / Line 32: @@
 * Declare a variable 'result' of type HANDLE
 * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Position.GetBox(handle)</pre>
-''<span style="color:red;">No additional examples</span>''