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

From Flowcode Help
Jump to navigationJump to search
 
(3 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 the position for the start point of the bar
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetStartPos'''
 
+
|-
<div style="width:25%; float:right" class="toc">
+
| colspan="2" | Sets the position for the start point of the bar&nbsp;
====Class hierarchy====
+
|-
[[API Panel|Panel]]
+
|-
:[[API Panel.LinkBar|LinkBar]]
+
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
::[[API Panel.LinkBar|SetStartPos]]
+
| width="90%" | LinkBar
</div>
+
|-
__TOC__
+
| colspan="2" | The handle to the bar to adjust the position of&nbsp;
 
+
|-
==Parameters==
+
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
[[Variable Types|HANDLE]] ''LinkBar''
+
| width="90%" | Pos
:The handle to the bar to adjust the position of
+
|-
 
+
| colspan="2" | The position to start the bar at&nbsp;
[[Variable Types|HANDLE]] ''Pos''
+
|-
:The position to start the bar at
+
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 
+
| width="90%" | Track
[[Variable Types|BOOL]] ''Track''
+
|-
:Automatically update the bar to match changes in the position
+
| colspan="2" | Automatically update the bar to match changes in the position&nbsp;
 
+
|-
 
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE
==Return value==
+
| width="90%" style="border-top: 2px solid #000;" | ''Return''
''This call does not return a value''
+
|}
  
  
Line 38: Line 38:
 
===Calling in a calculation===
 
===Calling in a calculation===
 
* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.LinkBar.SetStartPos(linkbar, pos, false)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">::Panel.LinkBar.SetStartPos(linkbar, pos, false)</pre>
 
''<span style="color:red;">No additional examples</span>''
 

Latest revision as of 11:54, 16 January 2023

Fc9-comp-macro.png SetStartPos
Sets the position for the start point of the bar 
Fc9-h32-icon.png - HANDLE LinkBar
The handle to the bar to adjust the position of 
Fc9-h32-icon.png - HANDLE Pos
The position to start the bar at 
Fc9-bool-icon.png - BOOL Track
Automatically update the bar to match changes in the position 
Fc9-void-icon.png - NONE Return


Detailed description

This sets the start position of the link. A link is a bar that connects this start position to an end point.


If Track is true, the start of the link will always follow the current position. Note, that while the position will update, only visible objects will cause the screen to refresh, so for objects that are not visible (hidden components or position objects) call Update on a position change or intermittently to ensure the bar redraws correctly.


Examples

Calling in a calculation

  • Add to a calculation icon:
    ::Panel.LinkBar.SetStartPos(linkbar, pos, false)