API Panel.Position.GetBox - Revision history

Wiki bot at 11:54, 16 January 2023

2023-01-16T11:54:48Z

2023-01-16T11:41:21Z

2014-01-16T15:57:54Z

XML import

2013-08-09T14:27:27Z

XML import of API documentation

2013-06-17T09:58:06Z

XML import of updated API docs

2013-06-14T22:21:46Z

2013-06-14T00:00:24Z

2013-06-10T11:09:09Z

XML Import to change Variable types into Variable Types

2013-05-14T13:13:46Z

XML import API changes

2013-05-12T21:51:37Z

XML import

← Older revision		Revision as of 11:54, 16 January 2023
Line 32:		Line 32:
	* Declare a variable 'result' of type HANDLE		* Declare a variable 'result' of type HANDLE
	* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Position.GetBox(handle)</pre>		* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Position.GetBox(handle)</pre>
−
−	~~''<span style="color:red;">No additional examples</span>''~~

@@ Line 1: / Line 1: @@
-<sidebar>API Contents</sidebar>
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-Gets a handle to an object representing the components bounding box position
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-<div style="width:25%; float:right" class="toc">
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetBox'''
-====Class hierarchy====
+|-
-[[API Panel|Panel]]
+| colspan="2" | Gets a handle to an object representing the components bounding box position&nbsp;
-:[[API Panel.Position|Position]]
+|-
-::[[API Panel.Position|GetBox]]
+|-
-</div>
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
-__TOC__
+| width="90%" | Handle
+|-
-==Parameters==
+| colspan="2" | The position or component to read from&nbsp;
-[[Variable Types|HANDLE]] ''Handle''
+|-
-:The position or component to read from
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
-:''The default value for this parameter is: '''''this'''
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}

← Older revision		Revision as of 15:57, 16 January 2014
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

← Older revision		Revision as of 14:27, 9 August 2013
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

@@ Line 1: / Line 1: @@
 <sidebar>API contents</sidebar>
 Gets a handle to an object representing the components bounding box position
@@ Line 38: / Line 40: @@
 * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Position.GetBox(handle)</pre>
-''<span style="color:red;">No additional information</span>''
+''<span style="color:red;">No additional examples</span>''

← Older revision		Revision as of 22:21, 14 June 2013
Line 26:		Line 26:


−	The difference between scale and size only applies to ~~grouped objects, or~~ objects with [[Component Tree\|child objects]].	+	The difference between [[Object Scale\|scale and size]] only applies to objects with [[Component Tree\|child objects]], such as groups or compiled components.
		+	{\|
		+	\|-
		+	\| [[File:SIMAPI Panel.Position.GetBox.svg\|thumb\|150px\|Scale and size of the box]]
		+	\|}

← Older revision		Revision as of 00:00, 14 June 2013
Line 23:		Line 23:

	==Detailed description==		==Detailed description==
−	''~~<span style="color:red;">No additional information</span>~~''	+	This call gets the objects bounding box position. This can be thought of as the objects ''[[Object_Scale\|size]]'' rather than its raw scale value.
		+
		+
		+	The difference between scale and size only applies to grouped objects, or objects with [[Component Tree\|child objects]].

@@ Line 11: / Line 11: @@
 ==Parameters==
-[[Variable types|HANDLE]] ''Handle''
+[[Variable Types|HANDLE]] ''Handle''
 :The position or component to read from
 :''The default value for this parameter is: '''''this'''
@@ Line 17: / Line 17: @@
 ==Return value==
-[[Variable types|HANDLE]]
+[[Variable Types|HANDLE]]
 Returns the handle to an object representing the components bounding box position