Difference between revisions of "API Component.GetParent"
From Flowcode Help
Jump to navigationJump to search (XML import API auto-gen) |
(XML import) |
||
(19 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | + | <sidebar>API Contents</sidebar> | |
Gets the owner of the components handle | Gets the owner of the components handle | ||
+ | <div style="width:25%; float:right" class="toc"> | ||
+ | ====Class hierarchy==== | ||
+ | [[API Component|Component]] | ||
+ | :[[API Component|GetParent]] | ||
+ | </div> | ||
+ | __TOC__ | ||
− | + | ==Parameters== | |
− | + | [[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''' | ||
− | + | ||
− | [[Variable | + | ==Return value== |
+ | [[Variable Types|HANDLE]] | ||
Returns the owner of the components handle | Returns the owner of the components handle | ||
− | |||
− | |||
− | ===Examples | + | ==Detailed description== |
− | + | This call will return the immediate parent of the component in the [[Component Tree|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 | * Declare a variable 'result' of type HANDLE | ||
− | * Add to a calculation icon: result = ::Component.GetParent(current) | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.GetParent(current)</pre> |
+ | |||
+ | ''<span style="color:red;">No additional examples</span>'' |
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Gets the owner of the components handle
Contents
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 examples