API Component.GetParent: Difference between revisions

Latest revision as of 14:11, 13 July 2026

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

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)

@@ Line 1: / Line 1: @@
-wiki page name
+{| class="mtx-class-macrotable wikitable"
-==ComponentGetParent==
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''GetParent'''
+|-
+| colspan="2" | Gets the owner of the component&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Current
+|-
+| colspan="2" | The component to find the parent of&nbsp;
+|-
+| 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''
+|}
-Gets the owner of the components handle
-----
-===Parameters===
+==Detailed description==
-''[[Variable types|HANDLE]] Current''
+This call will return the immediate parent of the component in the [[Component Tree|component tree]].
-:The component to find the parent of
-:''The default value for this parameter is: '''''this'''
-===Return value===
-[[Variable types|HANDLE]]
-Returns the owner of the components handle
+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.
-===Detailed description===
-''No additional information''
-===Examples===
+==Examples==
-====Calling in a calculation:====
+===Calling in a calculation===
 * 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>

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation