TimelineAddEvent(Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

TimelineAddEvent(Function)

In french: TimelineAjouteEvénement

Adds an event into a TimeLine control.

Example

// 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

TimelineAddEvent(TL_Music, MyTrack, MyTitle, EvtStart, EvtEnd)

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)

Syntax

Adding an element while specifying its characteristics Hide the details

<Result> = TimelineAddEvent(<TimeLine control> , <Track> , <Title> , <Start> [, <End> [, <Category>]])

<Result>: Integer

Subscript of added event,
-1 if an error occurred. ErrorInfo is used to identify the error.
Remark: The added event can be handled via its subscript by using the following notation: <TimeLine control>[<Subscript>]. You can modify the properties of this element.

<TimeLine control>: Control name

Name of TimeLine control into which the event will be added.

<Track>: Character string (with quotes)

Name of track associated with the event.

<Title>: Character string (with quotes)

Title of the event.

<Start>: Integer

Start of event. This parameter is expressed in the unit chosen for the display resolution of TimeLine control. If the display resolution is the second, this parameter will correspond to the start time of the event expressed in seconds.
Remark: The display resolution can be modified:
in the TimeLine control description window ("Details" tab).
with TimelineChangeMode.

<End>: Optional integer

End of event. This parameter is expressed in the unit chosen for the display resolution of TimeLine control.
If this parameter is not specified, the default duration of event will be set to 1 unit.

<Category>: Optional character string (with quotes)

Name of category associated with the event. If this parameter is not specified, the event is associated with no category. The category is automatically created if it does not exist.

Adding an event into a TimeLine control while using the EventTimeline type Hide the details

<Result> = TimelineAddEvent(<TimeLine control> , <Event>)

<Result>: Optional integer

Subscript of added event,
-1 if an error occurred. ErrorInfo is used to identify the error.
Remark: The added event can be handled via its subscript by using the following notation: <Name of TimeLine control>[<Subscript>]. You can modify the properties of this element.

<TimeLine control>: Control name

Name of TimeLine control into which the event will be added.

<Event>: EventTimeline variable

Name of the EventTimeline variable that describes the characteristics of the event to add.

Remarks

TimelineAddEvent is used to associate an event with a single track. To associate one event with several tracks, TimelineAddEvent must be called for each track.

Component: wd270mdl.dll