Difference between revisions of "API Panel.Position.Get"
From Flowcode Help
Jump to navigationJump to search (XML import API auto-gen) |
(XML import) |
||
| Line 2: | Line 2: | ||
Gets a handle to an object representing the components current position | Gets a handle to an object representing the components current position | ||
| + | <div style="width:25%; float:right" class="toc"> | ||
| + | ===Class hierarchy=== | ||
| + | :Panel | ||
| + | ::Position | ||
| + | :::Get | ||
| + | </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 current position | Returns the handle to an object representing the components current 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.Get(handle)</pre> |
Revision as of 16:01, 11 May 2013
<sidebar>API contents</sidebar> Gets a handle to an object representing the components current position
Class hierarchy
- Panel
- Position
- Get
- Position
Contents
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 current 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.Get(handle)
