Difference between revisions of "API Component.GetParent"
From Flowcode Help
Jump to navigationJump to search (XML import of API auto-gen) |
|||
| (16 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | |
| − | Gets the owner of the | + | |- |
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetParent''' | ||
| + | |- | ||
| + | | colspan="2" | Gets the owner of the component | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | ||
| + | | width="90%" | Current | ||
| + | |- | ||
| + | | colspan="2" | The component to find the parent of | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| − | == | + | ==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: <pre class="brush:[ | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.GetParent(current)</pre> |
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 |
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)
