API Panel.LinkBar.SetStartPos: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	SetStartPos
Sets the position for the start point of the bar
- HANDLE	LinkBar
The handle to the bar to adjust the position of
- HANDLE	Pos
The position to start the bar at
- BOOL	Track
Automatically update the bar to match changes in the position
- 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)

@@ 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" | '''SetStartPos'''
+|-
+| colspan="2" | Sets the position for the start point of the bar&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | LinkBar
+|-
+| colspan="2" | The handle to the bar to adjust the position of&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Pos
+|-
+| colspan="2" | The position to start the bar at&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" | Track
+|-
+| 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
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-<sidebar>API contents</sidebar>
+==Detailed description==
-Sets the position for the start point of the bar
+This sets the start position of the link. A link is a bar that connects this start position to an end point.
-<div style="width:25%; float:right" class="toc">
-====Class hierarchy====
-[[API Panel|Panel]]
-:[[API Panel.LinkBar|LinkBar]]
-::[[API Panel.LinkBar|SetStartPos]]
-</div>
-__TOC__
-==Parameters==
-[[Variable Types|HANDLE]] ''LinkBar''
-:The handle to the bar to adjust the position of
-[[Variable Types|HANDLE]] ''Pos''
-:The position to start the bar at
-[[Variable Types|BOOL]] ''Track''
-:Automatically update the bar to match changes in the position
-==Return value==
-''This call does not return a value''
+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 [[API Panel.LinkBar.Update|Update]] on a position change or intermittently to ensure the bar redraws correctly.
-==Detailed description==
-''<span style="color:red;">No additional information</span>''
@@ Line 34: / Line 38: @@
 ===Calling in a calculation===
 * Add to a calculation icon: <pre class="brush:[cpp]">::Panel.LinkBar.SetStartPos(linkbar, pos, false)</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