PC SOFT

ONLINE HELP
 WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English EN
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
..RulerValue is used to find out and modify the position of a ruler in a TimeLine control.
Reminder: The ruler of a TimeLine control corresponds to a "bold" vertical line used to view a specific moment in the control. The style of the ruler is defined in the "Style" tab of the TimeLine control ("Selected time" element).
Example
TimelineDeleteAll(TL_Robots)
Evt is EventTimeline
 
TimelineAddTrack(TL_Robots, "Robot 1")
Evt..Track = "Robot 1"
Evt..Title = "Start"
Evt..Start = 10
Evt..End = 150
Evt..BackgroundColor = LightGreen
TimelineAddEvent(TL_Robots, Evt)
 
Evt..Track = "Robot 1"
Evt..Title = "Special process"
Evt..Start = 150
Evt..End = 450
Evt..BackgroundColor = PastelBlue
TimelineAddEvent(TL_Robots, Evt)
 
// Positions the ruler at a specific moment
TL_Robots..RulerVisible = True
TL_Robots..RulerValue = 300
 
// -- Code for modifying the TimeLine control
// Displays the selected value in the static
STC_TimeLineRuler = TL_Robots..RulerValue
Syntax

Finding out the value of the ruler Hide the details

<Result> = <TimeLine control>..RulerValue
<Result>: Integer
Current position of the ruler. The unit used is identical to the one used for displaying the TimeLine control (second, millisecond of microsecond).
<TimeLine control>: Control name
Name of TimeLine control to use.

Modifying the value of the ruler Hide the details

<TimeLine control>..RulerValue = <New position>
<TimeLine control>: Control name
Name of TimeLine control to use.
<New position>: Integer
New position of the ruler. The unit used is identical to the one used for displaying the TimeLine control (second, millisecond of microsecond). This value must be included between ..StartTotalRange and ..EndTotalRange otherwise the ruler will be invisible.
Remarks
  • The ruler can be modified by the user:
    • if the "Modifiable pager" option is checked in the description window of the TimeLine control.
    • if ..RulerModifiable is set to True.
  • The end user can modify the value of the ruler by moving the line with the mouse. This action triggers the "Whenever modifying" event of the TimeLine control.
  • The default position of the ruler corresponds to ..StartTotalRange.
See also
Minimum version required
  • Version 18
This page is also available for…
Comments
Click [Add] to post a comment