Difference between revisions of "API Component.GetVisible"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
(8 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Gets whether a component can be seen on the panel
+
|-
 
+
| 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;" | '''GetVisible'''
====Class hierarchy====
+
|-
[[API Component|Component]]
+
| colspan="2" | Gets whether a component can be seen on the panel&nbsp;
:[[API Component|GetVisible]]
+
|-
</div>
+
|-
__TOC__
+
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 
+
| width="90%" | Target
==Parameters==
+
|-
[[Variable types|HANDLE]] ''Target''
+
| colspan="2" | The component to read the state from&nbsp;
:The component to read the state from
+
|-
:''The default value for this parameter is: '''''this'''
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
 
+
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
+
|}
==Return value==
 
[[Variable types|BOOL]]
 
 
 
Returns true if the operation is a success, else false
 
  
  
 
==Detailed description==
 
==Detailed description==
''<span style="color:red;">No additional information</span>''
+
An invisible component may still respond to mouse click events, but can not be seen on any panel during simulation. When not simulating, invisible components are displayed as a grey outline.
  
  
Line 29: Line 25:
 
* Declare a variable 'result' of type BOOL
 
* Declare a variable 'result' of type BOOL
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.GetVisible(target)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.GetVisible(target)</pre>
 
''<span style="color:red;">No additional information</span>''
 

Latest revision as of 11:54, 16 January 2023

Fc9-comp-macro.png GetVisible
Gets whether a component can be seen on the panel 
Fc9-h32-icon.png - HANDLE Target
The component to read the state from 
Fc9-bool-icon.png - BOOL Return


Detailed description

An invisible component may still respond to mouse click events, but can not be seen on any panel during simulation. When not simulating, invisible components are displayed as a grey outline.


Examples

Calling in a calculation

  • Declare a variable 'result' of type BOOL
  • Add to a calculation icon:
    result = ::Component.GetVisible(target)