API Panel.Position.GetBox: Difference between revisions
Appearance
XML import of API auto-gen |
XML import |
||
| Line 2: | Line 2: | ||
Gets a handle to an object representing the components bounding box position | Gets a handle to an object representing the components bounding box position | ||
<div style="width:25%; float:right" class="toc"> | |||
===Class hierarchy=== | |||
:Panel | |||
::Position | |||
:::GetBox | |||
</div> | |||
__TOC__ | |||
==Parameters== | |||
''[[Variable types|HANDLE]] Handle'' | ''[[Variable types|HANDLE]] Handle'' | ||
:The position or component to read from | :The position or component to read from | ||
:''The default value for this parameter is: '''''this''' | :''The default value for this parameter is: '''''this''' | ||
==Return value== | |||
[[Variable types|HANDLE]] | [[Variable types|HANDLE]] | ||
Returns the handle to an object representing the components bounding box position | Returns the handle to an object representing the components bounding box position | ||
==Detailed description== | |||
''No additional information'' | ''No additional information'' | ||
==Examples== | |||
===Calling in a calculation=== | |||
* Declare a variable 'result' of type HANDLE | * Declare a variable 'result' of type HANDLE | ||
* Add to a calculation icon: <pre class="brush:[ | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Panel.Position.GetBox(handle)</pre> | ||
Revision as of 16:04, 11 May 2013
<sidebar>API contents</sidebar> Gets a handle to an object representing the components bounding box position
Class hierarchy
- Panel
- Position
- GetBox
- Position
Parameters
HANDLE Handle
- The position or component to read from
- The default value for this parameter is: this
Return value
Returns the handle to an object representing the components bounding box position
Detailed description
No additional information
Examples
Calling in a calculation
- Declare a variable 'result' of type HANDLE
- Add to a calculation icon:
result = ::Panel.Position.GetBox(handle)