API Component.SetVisible: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	SetVisible
Sets whether a component can be seen on the panel
- HANDLE	Target
The component to set the state for
- BOOL	Enabled
True to enable, false to disable
- NONE	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

Add to a calculation icon:
```
::Component.SetVisible(target, true)
```

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Sets whether a component can be seen on the panel
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-<div style="width:25%; float:right" class="toc">
+| width="90%" class="mtx-class-macrohead" | '''SetVisible'''
-====Class hierarchy====
+|-
-[[API Component|Component]]
+| colspan="2" | Sets whether a component can be seen on the panel&nbsp;
-:[[API Component|SetVisible]]
+|-
-</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 set the state for&nbsp;
-:The component to set the state for
+|-
-:''The default value for this parameter is: '''''this'''
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" | Enabled
-[[Variable types|BOOL]] ''Enabled''
+|-
-:True to enable, false to disable
+| colspan="2" | True to enable, false to disable&nbsp;
+|-
-==Return value==
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE
-''This call does not return a value''
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
 ==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 28: / Line 29: @@
 ===Calling in a calculation===
 * Add to a calculation icon: <pre class="brush:[cpp]">::Component.SetVisible(target, true)</pre>
-''<span style="color:red;">No additional information</span>''

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation