Difference between revisions of "API Component.SetVisible"
From Flowcode Help
Jump to navigationJump to search (XML import API auto-gen) |
(XML import) |
||
| (18 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | API | + | <sidebar>API Contents</sidebar> |
Sets whether a component can be seen on the panel | Sets whether a component can be seen on the panel | ||
| + | <div style="width:25%; float:right" class="toc"> | ||
| + | ====Class hierarchy==== | ||
| + | [[API Component|Component]] | ||
| + | :[[API Component|SetVisible]] | ||
| + | </div> | ||
| + | __TOC__ | ||
| − | + | ==Parameters== | |
| − | + | [[Variable Types|HANDLE]] ''Target'' | |
:The component to set the state for | :The component to set the state for | ||
:''The default value for this parameter is: '''''this''' | :''The default value for this parameter is: '''''this''' | ||
| − | + | [[Variable Types|BOOL]] ''Enabled'' | |
:True to enable, false to disable | :True to enable, false to disable | ||
| − | + | ||
| + | ==Return value== | ||
''This call does not return a value'' | ''This call does not return a value'' | ||
| − | |||
| − | |||
| − | ===Examples | + | ==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. | |
| − | * Add to a calculation icon: ::Component.SetVisible(target, true) | + | |
| + | |||
| + | ==Examples== | ||
| + | ===Calling in a calculation=== | ||
| + | * Add to a calculation icon: <pre class="brush:[cpp]">::Component.SetVisible(target, true)</pre> | ||
| + | |||
| + | ''<span style="color:red;">No additional examples</span>'' | ||
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Sets whether a component can be seen on the panel
Contents
Parameters
HANDLE Target
- The component to set the state for
- The default value for this parameter is: this
BOOL Enabled
- True to enable, false to disable
Return value
This call does not return a value
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
- Add to a calculation icon:
::Component.SetVisible(target, true)
No additional examples
