Difference between revisions of "API Component.GetParent"

Latest revision as of 15:57, 16 January 2014

<sidebar>API Contents</sidebar> Gets the owner of the components handle

HANDLE Current

The component to find the parent of

The default value for this parameter is: this

Returns the owner of the components handle

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)

No additional examples

@@ Line 1: / Line 1: @@
-wiki page name
+<sidebar>API Contents</sidebar>
-==ComponentGetParent==
+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===
+==Parameters==
-''[[Variable types|HANDLE]] Current''
+[[Variable Types|HANDLE]] ''Current''
 :The component to find the parent of
 :''The default value for this parameter is: '''''this'''
-===Return value===
-[[Variable types|HANDLE]]
+==Return value==
+[[Variable Types|HANDLE]]
 Returns the owner of the components handle
-===Detailed description===
-''No additional information''
-===Examples===
+==Detailed description==
-====Calling in a calculation:====
+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
-* 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>''