PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
  • Properties specific to the description of TimelineEvent variables
  • Functions that use the EventTimeline variables
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
The EventTimeline type is used to define the advanced characteristics of an event. This event will be dispayed inside a TimeLine control. The characteristics of this event can be defined and modified by several WLanguage properties.
The corresponding event can then be used with WLanguage functions for Timeline control management.
Note: See Declaring a variable for more details.
Example
TimelineDeleteAll(TL_Robots)
Evt is EventTimeline

TimelineAddTrack(TL_Robots, "Robot 1")
Evt..Track = "Robot 1"
Evt..Title = "Startup"
Evt..Start = 10
Evt..End = 150
Evt..BrushColor = LightGreen
TimelineAddEvent(TL_Robots, Evt)

Evt..Track = "Robot 1"
Evt..Title = "Special process"
Evt..Start = 150
Evt..End = 450
Evt..BrushColor = PastelBlue
TimelineAddEvent(TL_Robots, Evt)

Evt..Track = "Robot 1"
Evt..Title = "Pause"
Evt..Start = 450
Evt..End = 700
Evt..BrushColor = LightRed
TimelineAddEvent(TL_Robots, Evt)

Evt..Track = "Robot 1"
Evt..Title = "Stop"
Evt..Start = 700
Evt..End = 750
Evt..BrushColor = PastelRed
TimelineAddEvent(TL_Robots, Evt)
Remarks

Properties specific to the description of TimelineEvent variables

The following properties can be used to handle an event:
Property nameType usedEffect
AuthorCharacter stringName of the event author. If this property is not specified, the event has no author.
WithRepetitionBoolean
  • True if the event must be repeated,
  • False if the event only happens once.
If the event is repeated, ..Repetition is used to specify the frequency of the repetition.
This property is set to False by default.
TooltipCharacter stringTooltip displayed when the event is hovered. By default, this value includes the start and end times of the event as well as the event title.
CategoryCharacter stringCategory of the event. If this property is not specified, the event is associated with no category.
ContentCharacter stringDetailed description of the event. The content is displayed in the TimeLine control.
If this property is not specified, the event has no description.
BrushColorIntegerBackground color used to display the event in the TimeLine control.
This color corresponds to:If this property is not specified, a color will be automatically calculated. The events of the same category will have the same color.
StartIntegerStart of the event. This property must use the same unit as the one used to display the TimeLine control (second, millisecond or microsecond).
This property must necessarily be specified.
EndIntegerEnd of the event. This property must use the same unit as the one used to display the TimeLine control (second, millisecond or microsecond).
This property must necessarily be specified.
IDCharacter stringIdentifier associated with the event. Allows you to store the identifier of an element that must be associated with the element in order to use it later in programming.
For example, this identifier can correspond to the identifier of a record in a database.
ImageCharacter stringImage associated with the event. This image is displayed in the TimeLine control (in addition to the logo that represents an important element if necessary).
This property can correspond to:
  • the path to an image accessible from the current computer,
  • an image file found in the library of the application,
  • an Image control containing an image,
  • a drawing performed in an Image control with the drawing functions and saved in memory.
If this property is not specified, the event has no associated image.
Note: An internal window must be used to display an image in the event. The simple style (proposed by default) cannot be used to display an image.
ImportanceIntegerImportance of the event.
If this property is greater than or equal to 1, a pictogram ( Pictogram for important event. ) will be displayed in the TimeLine control to indicate an important event.
If this property is not specified, its value is set to 0.
NoteCharacter stringNote associated with the event.
If this property is not specified, no note is associated with the event.
TrackCharacter stringTrack associated with the event.
RepetitionRepetition variableAdvanced parameters of repetition. This property is taken into account only if ..WithRepetition is set to True.
TitleCharacter stringTitle of the event. The title is displayed in the Timeline control.
If this property is not specified, the event has no title.
Note: These properties can be used with one of the following syntaxes:
  • <Variable Name>..<Property Name>
  • <Variable Name>.<Property Name>

Functions that use the EventTimeline variables

Versions 18 and later
TimelineAddEvent
New in version 18
TimelineAddEvent
TimelineAddEvent
Adds an event into a TimeLine control.
Minimum required version
  • Version 18
Comments
Click [Add] to post a comment