Manipulating TimeLine controls programmatically (prefix syntax)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / Developing an application or website / Controls, windows and pages / Controls: Available types / TimeLine control

Overview
Manipulating TimeLine controls programmatically
Adding a track
Adding an event
Populating a TimeLine control with the data from an HFSQL data file
Retrieving a list of events
Deleting an event
Deleting a track
Changing the time scale of the control
Using the context menu (AAF)
Advanced use of the events associated with the Timeline control
Advanced use of events with procedures
Properties specific to TimeLine controls

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

Manipulating TimeLine controls programmatically (prefix syntax)

Overview

A TimeLine control can be:

manipulated programmatically.
linked to a data file.
bound to a variable.

In WINDEV, you can use TimeLine functions to manipulate TimeLine controls programmatically.

This help page explains how to programmatically manipulate TimeLine controls. The example below stores the events in an HFSQL database.

Manipulating TimeLine controls programmatically

Adding a track

To add a track to a TimeLine control, call <TimeLine>.AddTrack.

Example:

// Ajoute des pistes dans un champ TimeLine TL_TimeLine1 
TL_TimeLine1.AjoutePiste("Sub Bass")
TL_TimeLine1.AjoutePiste("Scratchy Drums")
TL_TimeLine1.AjoutePiste("Guitar 1")

Remark: The <TimeLine>.AddTrack function inserts a background image into the track.

Adding an event

To add an event to a TimeLine control, use <TimeLine>.AddEvent. This function accepts two syntaxes:

syntax for specifying event characteristics: title, description, ...

// Adds a 5-second event into a TimeLine control configured to the second
MyTrack is string
MyTitle is string
EvtStart is int
EvtEnd is int 

MyTrack = "Strings"
MyTitle = "Start"
EvtStart = 4
EvtEnd = 9

TL_Music.AddEvent(MyTrack, MyTitle, EvtStart, EvtEnd)

syntax that handles a variable of type EventTimeline.

TL_Automates.SupprimeTout()
Evt is EventTimeline
TL_Automates.AjoutePiste("Automate 1")
Evt.Track = "Automate 1"
Evt.Title = "Démarrage"
Evt.Start = 10
Evt.End = 150
Evt.BackgroundColor = LightGreen
TL_Automates.AjouteEvénement(Evt)
Evt.Track = "Automate 1"
Evt.Title = "Traitement spécial"
Evt.Start = 150
Evt.End = 450
Evt.BackgroundColor = PastelBlue
TL_Automates.AjouteEvénement(Evt)

The BackgroundColor property of the EventTimeline variable is used to define the color used to display an event. If no background color is defined, the TimeLine control will automatically use the color associated with the category of the event.

Populating a TimeLine control with the data from an HFSQL data file

The records are stored in an HFSQL data file. To populate the TimeLine control for the first time, you can use a FOR EACH loop or add each event with <TimeLine>.AddEvent.

TL_Automates.SupprimeTout()
// Déclaration des événements
Evt is EventTimeline

// Parcours du fichier de données Automate
FOR EACH Automate 
	TL_Automate.AjoutePiste(Automate.NomAutomate)
	// Parcours du fichier de données Evt_Automate
	FOR EACH Evt_Automate where IDAutomate = Automate.IDAutomate
		Evt.ToolTip = Evt_Automate.EvtBulle
		Evt.Title = Evt_Automate.EvtTitre
		Evt.Start = Evt_Automate.EvtDébut
		Evt.End = Evt_Automate.EvtFin
		Evt.Content = Evt_Automate.EvtContenu
		Evt.Track = Automate.NomAutomate
		Evt.BackgroundColor = Evt_Automate.EvtCouleur
		TL_Automates.AjouteEvénement(Evt)
	END
END

Remember: It's also possible to use a TimeLine field linked to a data file.. For more details, see TimeLine control linked to a data file.

Retrieving a list of events

TimelineListEvent is used to retrieve:

the list of all events in the TimeLine control:

// Tableau contenant une liste des événements 
tabListeEvt is array of EventTimeline
// Liste des événements
tabListeEvt = TL_TimeLine.ListeEvénement()

the list of events of a track between two specific times:

// Liste des événements de l'automate 1 compris entre 50s et 100s 
tabListeEvt is array of EventTimeline
tabListeEvt = TL_Automates.ListeEvénement("Automate 1", 50, 100)

the currently selected or hovered event:

// Evénement sélectionné 
tabListeEvt is array of EventTimeline

tabListeEvt = TL_Automates.ListeEvénement(schAptSelected)

Deleting an event

<TimeLine>.DeleteEvent is used to delete:

the event selected in the control.
a specific event.

// Supprime le premier événement 
TL_MonTimeLine.SupprimeEvénement(1)

Deleting a track

<TimeLine>.DeleteTrack is used to delete a track from the TimeLine control.

// Supprime la piste SON 
ResSup is boolean
ResSup = TL_MonTimeLine.SupprimePiste("Son")
IF ResSup = True THEN
	Info("Piste supprimée")
END

<TimeLine>.DeleteAll is used to delete all the events from the TimeLine control as well as all its tracks.

Changing the time scale of the control

You can change the time scale of a TimeLine control with <TimeLine>.ChangeMode. This function can be used to change the field display mode: second, millisecond or microsecond..

Using the context menu (AAF)

The Timeline control is associated with a context menu (AAF). The context menu of the TimeLine control allows you to:

zoom or out in the control,
add, modify or delete an event.

To save the operations performed, you must use the WLanguage events associated with the TimeLine control.

In the corresponding WLanguage event, simply retrieve the event currently used and perform the corresponding process.

Example: To store in an "EVT" data file an event added by the user via the context menu, simply enter the following code in the "Event entry" event:

PROCEDURE EntréeEnSaisie(evtEdité is EventTimeline)
// Mémorisation des données
EVT.Titre = evtEdité.Titre
EVT.DébutEvt = evtEdité.Début
EVT.FinEvt = evtEdité.Fin
...
HAdd(EVT)

The same type of code can be implemented for the different events associated with the TimeLine control. A procedure is automatically declared by the TimeLine control for each WLanguage event associated with the control that handles an event.

These procedures receive a variable of type EventTimeline as parameter.

Advanced use of the events associated with the Timeline control

Advanced use of events with procedures

You can also allow users to define more precisely the characteristics of the events when they are added or modified. To do so, create a window with the information to specify.

In the code, specify that the window must be opened in the "Enter input mode in an event" event. To lock the direct input, the process must return False.

This principle can be applied to all WLanguage events called via the context menu of the TimeLine control.

Example: Opening a window for entering the event.

PROCEDURE EntréeEnSaisie(evtEdité is EventTimeline)
// Ouvre la fenêtre de saisie d'un événement
// avec l'événement sélectionné (en mode Création ou Modification)
Open(FEN_SaisieEvt_HFSQL, evtEdité)
// Renvoie FAUX pour bloquer la saisie directe dans le champ TimeLine
RETURN False

Properties specific to TimeLine controls

The following properties are used to manipulate TimeLine controls.


EndTotalRange	The EndTotalRange property is used to: get the last date or time that can be displayed in a Scheduler or TimeLine control. change the last time that can be displayed in a TimeLine control.
EndVisibleRange	The EndVisibleRange property is used to: find out and modify the last visible date or time in a Scheduler control or in a TimeLine control. modify the last visible time in a TimeLine control.
GranularityDuration	The GranularityDuration property gets and sets the size of the grid to resize: appointments in an Organizer control. appointments in a Scheduler control. events in a TimeLine control. tasks in a Gantt Chart column.
GranularityMovement	The GranularityMovement property gets and sets the size of the grid to move: appointments in an Organizer control. appointments in a Scheduler control. events in a TimeLine control. tasks in a Gantt Chart column.
RulerModifiable	The RulerModifiable property is used to: Find out whether the user can move the playhead in a TimeLine control. Allow or prevent the user from moving the playhead in a TimeLine control.
RulerValue	The RulerValue property is used to get or change the position of the playhead in a TimeLine control.
RulerVisible	The RulerVisible property is used to: Determine if a playhead is visible in a TimeLine control. Show or hide a playhead in a TimeLine control.
StartTotalRange	The StartTotalRange property is used to: get the first date or time that will be displayed in a Scheduler or TimeLine control. change the first time that can be displayed in a TimeLine control.
StartVisibleRange	The StartVisibleRange property is used to: get and change the first visible date or time in a Scheduler or TimeLine control. change the first visible time in a TimeLine control.

For a complete list of WLanguage properties that can be used with TimeLine controls, see TimeLine control properties.