Difference between revisions of "API Component.GetParent"

Latest revision as of 11:54, 16 January 2023

	GetParent
Gets the owner of the component
- HANDLE	Current
The component to find the parent of
- HANDLE	Return

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.

Add to a calculation icon:

result = ::Component.GetParent(current)

@@ Line 1: / Line 1: @@
-<sidebar>API Contents</sidebar>
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-Gets the owner of the components handle
+|-
+| 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;" | '''GetParent'''
-====Class hierarchy====
+|-
-[[API Component|Component]]
+| colspan="2" | Gets the owner of the component&nbsp;
-:[[API Component|GetParent]]
+|-
-</div>
+|-
-__TOC__
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Current
-==Parameters==
+|-
-[[Variable Types|HANDLE]] ''Current''
+| colspan="2" | The component to find the parent of&nbsp;
-:The component to find the parent of
+|-
-:''The default value for this parameter is: '''''this'''
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-==Return value==
-[[Variable Types|HANDLE]]
-Returns the owner of the components handle
@@ Line 32: / Line 28: @@
 * Declare a variable 'result' of type HANDLE
 * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.GetParent(current)</pre>
-''<span style="color:red;">No additional examples</span>''