Jump to content

API Component.GetParent: Difference between revisions

From Flowcode Help
JonnyW (talk | contribs)
XML import of API documentation
m Text replacement - "width="90%" style="background-color:#D8C9D8; color:#4B008D;"" to "width="90%" class="mtx-class-macrohead""
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
{| class="mtx-class-macrotable wikitable"
 
|-
<sidebar>API Contents</sidebar>
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
Gets the owner of the components handle
| width="90%" class="mtx-class-macrohead" | '''GetParent'''
 
|-
<div style="width:25%; float:right" class="toc">
| colspan="2" | Gets the owner of the component&nbsp;
====Class hierarchy====
|-
[[API Component|Component]]
|-
:[[API Component|GetParent]]
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
</div>
| width="90%" | Current
__TOC__
|-
 
| colspan="2" | The component to find the parent of&nbsp;
==Parameters==
|-
[[Variable Types|HANDLE]] ''Current''
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
:The component to find the parent of
| width="90%" style="border-top: 2px solid #000;" | ''Return''
:''The default value for this parameter is: '''''this'''
|}
 
 
==Return value==
[[Variable Types|HANDLE]]
 
Returns the owner of the components handle




Line 34: Line 28:
* Declare a variable 'result' of type HANDLE
* Declare a variable 'result' of type HANDLE
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.GetParent(current)</pre>
* 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 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)