API Component.GetParent: Difference between revisions
No edit summary |
XML Import to change Variable types into Variable Types |
||
| Line 10: | Line 10: | ||
==Parameters== | ==Parameters== | ||
[[Variable | [[Variable Types|HANDLE]] ''Current'' | ||
:The component to find the parent of | :The component to find the parent of | ||
:''The default value for this parameter is: '''''this''' | :''The default value for this parameter is: '''''this''' | ||
| Line 16: | Line 16: | ||
==Return value== | ==Return value== | ||
[[Variable | [[Variable Types|HANDLE]] | ||
Returns the owner of the components handle | Returns the owner of the components handle | ||
Revision as of 11:08, 10 June 2013
<sidebar>API contents</sidebar> Gets the owner of the components handle
Parameters
HANDLE Current
- The component to find the parent of
- The default value for this parameter is: this
Return value
Returns the owner of the components handle
Detailed description
This call will return the immediate parent of the component in the component tree.
Note the parent of an object is not always a compiled component, and may be a group or in some circumstances even a built-in shape or text object.
Examples
Calling in a calculation
- Declare a variable 'result' of type HANDLE
- Add to a calculation icon:
result = ::Component.GetParent(current)
No additional information