Jump to content

API Component.GetVisible: Difference between revisions

From Flowcode Help
Admin (talk | contribs)
XML import API auto-gen
Admin (talk | contribs)
XML import
Line 2: Line 2:
Gets whether a component can be seen on the panel
Gets whether a component can be seen on the panel


<div style="width:25%; float:right" class="toc">
===Class hierarchy===
:Component
::GetVisible
</div>
__TOC__


===Parameters===
==Parameters==
''[[Variable types|HANDLE]] Target''
''[[Variable types|HANDLE]] Target''
:The component to read the state from
:The component to read the state from
:''The default value for this parameter is: '''''this'''
:''The default value for this parameter is: '''''this'''


===Return value===
==Return value==
[[Variable types|BOOL]]
[[Variable types|BOOL]]


No additional information
No additional information


===Detailed description===
==Detailed description==
''No additional information''
''No additional information''


===Examples===
==Examples==
====Calling in a calculation====
===Calling in a calculation===
* Declare a variable 'result' of type BOOL
* Declare a variable 'result' of type BOOL
* Add to a calculation icon: <pre class="brush:[C]">result = ::Component.GetVisible(target)</pre>
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.GetVisible(target)</pre>

Revision as of 15:35, 11 May 2013

<sidebar>API contents</sidebar> Gets whether a component can be seen on the panel

Class hierarchy

Component
GetVisible

Parameters

HANDLE Target

The component to read the state from
The default value for this parameter is: this

Return value

BOOL

No additional information

Detailed description

No additional information

Examples

Calling in a calculation

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