API Panel.LinkBar.SetVisible: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	SetVisible
Sets whether the link is displayed or not
- HANDLE	LinkBar
The handle to the bar to set the state of
- BOOL	Visible
True if the link is to be shown, false if not
- NONE	Return

Detailed description

This sets whether the bar is visible or not. If the bar is invisible, its position can still be retrieved for use in kinematics, etc.

If the bar should only be shown during simulation or design modes, the user may set the visibility during the Simulation.Start and Simulation.Stop events.

Examples

Calling in a calculation

Add to a calculation icon:

::Panel.LinkBar.SetVisible(linkbar, true)

@@ Line 1: / Line 1: @@
+{| class="mtx-class-macrotable wikitable"
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''SetVisible'''
+|-
+| colspan="2" | Sets whether the link is displayed or not&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | LinkBar
+|-
+| colspan="2" | The handle to the bar to set the state of&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" | Visible
+|-
+| colspan="2" | True if the link is to be shown, false if not&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-<sidebar>API contents</sidebar>
+==Detailed description==
-Sets whether the link is displayed or not
+This sets whether the bar is visible or not. If the bar is invisible, its position can still be retrieved for use in kinematics, etc.
-<div style="width:25%; float:right" class="toc">
-====Class hierarchy====
-[[API Panel|Panel]]
-:[[API Panel.LinkBar|LinkBar]]
-::[[API Panel.LinkBar|SetVisible]]
-</div>
-__TOC__
-==Parameters==
-[[Variable Types|HANDLE]] ''LinkBar''
-:The handle to the bar to set the state of
-[[Variable Types|BOOL]] ''Visible''
-:True if the link is to be shown, false if not
+If the bar should only be shown during simulation or design modes, the user may set the visibility during the [[Event Simulation.Start|Simulation.Start]] and [[Event Simulation.Stop|Simulation.Stop]] events.
-==Return value==
-''This call does not return a value''
-==Detailed description==
-''<span style="color:red;">No additional information</span>''
@@ Line 31: / Line 33: @@
 ===Calling in a calculation===
 * Add to a calculation icon: <pre class="brush:[cpp]">::Panel.LinkBar.SetVisible(linkbar, true)</pre>
-''<span style="color:red;">No additional examples</span>''

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation