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

From Flowcode Help
Jump to navigationJump to search
(XML import)
Line 1: Line 1:
<sidebar>API Contents</sidebar>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Sets the position for the start point of the bar
+
|-
 
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
<div style="width:25%; float:right" class="toc">
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetStartPos'''
====Class hierarchy====
+
|-
[[API Panel|Panel]]
+
| colspan="2" | Sets the position for the start point of the bar&nbsp;
:[[API Panel.LinkBar|LinkBar]]
+
|-
::[[API Panel.LinkBar|SetStartPos]]
+
|-
</div>
+
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
__TOC__
+
| width="90%" | LinkBar
 
+
|-
==Parameters==
+
| colspan="2" | The handle to the bar to adjust the position of&nbsp;
[[Variable Types|HANDLE]] ''LinkBar''
+
|-
:The handle to the bar to adjust the position of
+
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 
+
| width="90%" | Pos
[[Variable Types|HANDLE]] ''Pos''
+
|-
:The position to start the bar at
+
| colspan="2" | The position to start the bar at&nbsp;
 
+
|-
[[Variable Types|BOOL]] ''Track''
+
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
:Automatically update the bar to match changes in the position
+
| width="90%" | Track
 
+
|-
 
+
| colspan="2" | Automatically update the bar to match changes in the position&nbsp;
==Return value==
+
|-
''This call does not return a value''
+
| 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''
 +
|}
  
  

Revision as of 11:41, 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)

No additional examples