Difference between revisions of "API Component.GetVisible"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
| (13 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | <sidebar>API Contents</sidebar> | |
| − | + | Gets whether a component can be seen on the panel | |
| − | + | <div style="width:25%; float:right" class="toc"> | |
| − | + | ====Class hierarchy==== | |
| + | [[API Component|Component]] | ||
| + | :[[API Component|GetVisible]] | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
| − | + | [[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== | |
| + | [[Variable Types|BOOL]] | ||
| + | |||
| + | Returns true if the operation is a success, else false | ||
| + | |||
| − | + | ==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 | * Declare a variable 'result' of type BOOL | ||
| − | * Add to a calculation icon: result = ::Component.GetVisible(target) | + | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Component.GetVisible(target)</pre> |
| + | |||
| + | ''<span style="color:red;">No additional examples</span>'' | ||
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Gets whether a component can be seen on the panel
Contents
Parameters
HANDLE Target
- The component to read the state from
- The default value for this parameter is: this
Return value
Returns true if the operation is a success, else false
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)
No additional examples
