Difference between revisions of "API Panel.LinkBar.SetVisible"

From Flowcode Help
Jump to navigationJump to search
(XML import of API documentation)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
+
|-
<sidebar>API Contents</sidebar>
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
Sets whether the link is displayed or not
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetVisible'''
 
+
|-
<div style="width:25%; float:right" class="toc">
+
| colspan="2" | Sets whether the link is displayed or not&nbsp;
====Class hierarchy====
+
|-
[[API Panel|Panel]]
+
|-
:[[API Panel.LinkBar|LinkBar]]
+
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
::[[API Panel.LinkBar|SetVisible]]
+
| width="90%" | LinkBar
</div>
+
|-
__TOC__
+
| colspan="2" | The handle to the bar to set the state of&nbsp;
 
+
|-
==Parameters==
+
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
[[Variable Types|HANDLE]] ''LinkBar''
+
| width="90%" | Visible
:The handle to the bar to set the state of
+
|-
 
+
| colspan="2" | True if the link is to be shown, false if not&nbsp;
[[Variable Types|BOOL]] ''Visible''
+
|-
:True if the link is to be shown, false if not
+
| 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''
 
+
|}
==Return value==
 
''This call does not return a value''
 
  
  
Line 35: Line 33:
 
===Calling in a calculation===
 
===Calling in a calculation===
 
* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.LinkBar.SetVisible(linkbar, true)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.LinkBar.SetVisible(linkbar, true)</pre>
 
''<span style="color:red;">No additional examples</span>''
 

Latest revision as of 11:54, 16 January 2023

Fc9-comp-macro.png SetVisible
Sets whether the link is displayed or not 
Fc9-h32-icon.png - HANDLE LinkBar
The handle to the bar to set the state of 
Fc9-bool-icon.png - BOOL Visible
True if the link is to be shown, false if not 
Fc9-void-icon.png - 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)