Difference between revisions of "API Panel.LinkBar.SetStartPos"
From Flowcode Help
Jump to navigationJump to search (XML import of LinkBar API) |
|||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetStartPos''' | ||
| + | |- | ||
| + | | colspan="2" | Sets the position for the start point of the bar | ||
| + | |- | ||
| + | |- | ||
| + | | 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 | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | ||
| + | | width="90%" | Pos | ||
| + | |- | ||
| + | | colspan="2" | The position to start the bar at | ||
| + | |- | ||
| + | | 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 | ||
| + | |- | ||
| + | | 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'' | ||
| + | |} | ||
| − | + | ==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 [[API Panel.LinkBar.Update|Update]] on a position change or intermittently to ensure the bar redraws correctly. | ||
| − | |||
| − | |||
| Line 34: | 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> | ||
| − | |||
| − | |||
Latest revision as of 11:54, 16 January 2023
|
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)
