TimelineListEvent (Function) In french: TimelineListeEvénement Returns: - the list of events found between two given times in a TimeLine control,
- all events of a TimeLine control,
- a specific event (selected or hovered).
// Lists all events of TimeLine control
arrEvt is array of EventTimeline
arrEvt = TimelineListEvent(TL_TimeLine)
// Adds the events into a Table control
FOR EACH gMyEvent OF arrEvt
TableAddLine(TABLE_Table1, gMyEvent.Track, ...
gMyEvent.Start, gMyEvent.End, gMyEvent.Title)
END
// Lists the events from a given time
arrEvt is array of EventTimeline
arrEvt = TimelineListEvent(TL_Robots, "Robot 1", 70)
FOR EACH gMyEvent OF arrEvt
Trace(gMyEvent.Start, gMyEvent.End, gMyEvent.Title)
END
Syntax
Retrieving the list of events between two times Hide the details
<Result> = TimelineListEvent(<TimeLine control> [, <Track> [, <Start> [, <End>]]])
<Result>: Array of EventTimeline variables Array containing the EventTimeline variables.
If an event corresponding to the specified criteria is found, this array will contain a single element.
If no event corresponds to the specified criteria, this array will contain 0 event. <TimeLine control>: Control name Name of the TimeLine control to be used. <Track>: Optional character string Name of track to which the events are associated. If this parameter is not specified (or is an empty string), all the events from all the tracks will be returned. <Start>: Optional integer Start of event selection.
If this parameter is not specified, all the events found in the TimeLine control will be returned. <End>: Optional integer End of event selection.
If this parameter is not specified, all the events found from <Start> will be returned.
Retrieving information about a specific event Hide the details
<Result> = TimelineListEvent(<TimeLine control> , <Event type>)
<Result>: Array of EventTimeline variables Name of array containing the EventTimeline variables.
If an event corresponding to the specified criteria is found, this array will contain a single element.
If no event corresponds to the specified criteria, this array will contain 0 event. <TimeLine control>: Control name Name of the TimeLine control to be used. <Event type>: Integer constant Type of event sought:
| | | tlEveHovered | Event hovered by the mouse in the TimeLine control. If no event is hovered, <Result> will correspond to an array of 0 element. | | tlEveSelected | Event currently selected in the TimeLine control. If no event is selected, <Result> will correspond to an array of 0 element. |
This page is also available for…
|
|
|
|