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

From Flowcode Help
Jump to navigationJump to search
(XML import of LinkBar API)
 
(XML import)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
+
<sidebar>API Contents</sidebar>
 
 
<sidebar>API contents</sidebar>
 
 
Gets the position the bars start point is located at
 
Gets the position the bars start point is located at
  
Line 27: Line 25:
  
 
==Detailed description==
 
==Detailed description==
''<span style="color:red;">No additional information</span>''
+
The start position is specified on creation of the link or in the [[API Panel.LinkBar.SetStartPos|SetStartPos]] call. This will extract the latest version of this, which may not contain the same values as the original if the position is being tracked.
  
  

Latest revision as of 15:57, 16 January 2014

<sidebar>API Contents</sidebar> Gets the position the bars start point is located at

Class hierarchy

Panel

LinkBar
GetStartPos

Parameters

HANDLE LinkBar

The handle to the bar to read

BOOL Track

True to get a handle to the original position, false to make a copy


Return value

HANDLE

Returns the position the bars start point is located at


Detailed description

The start position is specified on creation of the link or in the SetStartPos call. This will extract the latest version of this, which may not contain the same values as the original if the position is being tracked.


Examples

Calling in a calculation

  • Declare a variable 'result' of type HANDLE
  • Add to a calculation icon:
    result = ::Panel.LinkBar.GetStartPos(linkbar, true)

No additional examples