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/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
The RulerValue property is used to get or change the position of the playhead in a TimeLine control.
Reminder: The playhead of a TimeLine control is a bold vertical line that represents a specific point in the control. The style of the playhead can be defined in the "Style" tab of the TimeLine control ("Selected time").
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 playhead at a specific point
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 playhead Hide the details

<Result> = <TimeLine control>.RulerValue
<Result>: Integer
Current position of the playhead. 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 playhead 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 playhead. The unit used is identical to the one used for displaying the TimeLine control (second, millisecond of microsecond). This value must be between the values of the StartTotalRange and EndTotalRange properties, otherwise the playhead will be invisible.
Remarks
  • The user can move the playhead:
    • if the "Movable playhead" option is checked in the description window of the TimeLine control.
    • if the RulerModifiable property is set to True.
  • The end user can change the value of the playhead by moving it with the mouse. This action triggers the "Whenever modifying" event of the TimeLine control.
  • The default position of the playhead corresponds to the value of the StartTotalRange property.
See also
Minimum version required
  • Version 18
This page is also available for…
Comments
Click [Add] to post a comment