Scheduler control events

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

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

Default events
Events supported by WINDEV and WINDEV Mobile
Events supported in WEBDEV
Events with procedures
Advanced use of events with procedures
Optional events

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

Scheduler control events

Default events

Events supported by WINDEV and WINDEV Mobile

The following events appear by default in the WINDEV and WINDEV Mobile code editor:

Event	Runtime condition

Initializing	Executed when the window is opened. *
Before creating the appointment	Run: when "New appointment" is selected in the context menu of Scheduler control. during the direct input of a new appointment via the keyboard. To create an appointment ("Allow the direct input of an appointment" option in the "Details" tab of the description window of control): Click on the Scheduler control: the selected period is highlighted and a "+" sign is displayed.. Click on the "+" sign: the "Before appointment creation" event is executed.. The appointment passed as parameter contains the start and end dates of the appointment. If this event returns nothing or True, the appointment is added and the Scheduler control is refreshed.
Enter an appointment in input	Run: when "New appointment" is selected in the context menu of Scheduler control. during the direct input of a new appointment via the keyboard. This event is run immediately after the "Before creating the appointment" event.
Exit from input for the appointment	Executed when exiting the input of an appointment (e.g., exit when adding an appointment or when editing an appointment via the context menu)
Selecting an appointment	Executed when an existing appointment is selected in the Scheduler control.
Moving an appointment	Executed when an appointment is moved in the Scheduler control. This event is run at the end of the movement with the mouse (when the mouse is "released"). Remark: The move is cancelled if this event executes the following line of code: `RETURN False` To move an appointment, a long press is required: the appointment then switches to move mode and can be moved with the finger to its destination.. This event is run at the end of the move.
Resizing an appointment	Executed when resizing an appointment in the Scheduler control (resize operation performed with the mouse for example). This event is run at the end of the resize (when the mouse is "released").
Deleting an appointment	Run: when "Delete the appointment" is selected in the context menu of Scheduler control. when an appointment is deleted via the DEL key of keyboard.
Range selection	Executed when selecting a time period in the Scheduler control (click performed on a time range for example). When several time ranges are selected with the mouse, the event is run for each new selected range.
Whenever changing period	Executed when modifying the period displayed in the Scheduler control (via the arrow buttons found at the top left of Scheduler control or when the period is changed through programming with SchedulerDisplayPreviousPeriod and SchedulerDisplayNextPeriod). Executed when modifying the period displayed in the Scheduler control (swipe performed in the Scheduler control or when the period is changed through programming with SchedulerDisplayPreviousPeriod and SchedulerDisplayNextPeriod).
Reassigning an appointment	Executed when moving an appointment triggers the modification of the resource associated with the appointment.
Whenever changing the display mode	Executed when the user changes the display mode of the Scheduler control. The new mode can be known in this event via SchedulerMode.

(*) By default, the "Initialization" event of each control is executed according to the order in which the controls were created in the window. To modify this runtime order:

On the "Window" tab, in the "Order" group, click "Initialization".
In the window that appears, use the arrows on the right to change the order in which the controls are initialized.

Events supported in WEBDEV

The following events appear by default in the WEBDEV code editor:

Event	Runtime condition

Initialization (server code)	Executed when the page is opened.
Moving an appointment (server code)	Executed when an appointment is moved in the Scheduler control. This event is run at the end of the movement with the mouse (when the mouse is "released").
Resizing an appointment (server code)	Executed when resizing an appointment in the Scheduler control (resize operation performed with the mouse for example). This event is run at the end of the resize (when the mouse is "released").
Deleting an appointment (server code)	Executed when the appointment is deleted. This deletion is performed when clicking the icon for appointment deletion (the red cross) displayed on the right of selected appointment.
Before creating the appointment (server code)	Run during the direct input of a new appointment with the keyboard. To perform the direct input, all you have to do is double-click the appointment and type its title.
Exit from appointment input (server code)	Run during the exit from appointment input (exit when adding an appointment or when modifying an appointment for example). This exit corresponds to the [ENTER] key pressed to validate the input.
Whenever the period changes (server code)	Executed when the period displayed in the Scheduler control is modified (via the arrow buttons found at the top left of Scheduler control).
Reassigning an appointment (server code)	Executed when moving an appointment triggers the modification of the resource associated with the appointment.
Selecting an appointment (browser code)	Executed when an existing appointment is selected in the Scheduler control.
Moving an appointment (browser code)	Executed when an appointment is moved in the Scheduler control. This event is run at the end of the movement with the mouse (when the mouse is "released").
Resizing an appointment (browser code)	Executed when resizing an appointment in the Scheduler control (resize operation performed with the mouse for example). This event is run at the end of the resize (when the mouse is "released").
Selecting a period (browser code)	Executed when a time range is selected in the Scheduler control.
Deleting an appointment (browser code)	Executed when the appointment is deleted. This deletion is performed when clicking the icon for appointment deletion (the red cross) displayed on the right of selected appointment.
Before creating the appointment (browser code)	Run during the direct input of a new appointment with the keyboard. To perform the direct input, all you have to do is double-click the appointment and type its title.
Enter an appointment in input (browser code)	Run during the direct input of the appointment. To perform the direct input, all you have to do is double-click the appointment and type its title. This event is run after the "Before creating the appointment" event.
Exit from appointment input (browser code)	Run during the exit from appointment input (exit when adding an appointment or when modifying an appointment for example). This exit corresponds to pressing Enter to validate the input.
Reassigning an appointment (browser code)	Executed when moving an appointment triggers the modification of the resource associated with the appointment.

Events with procedures

To handle appointments in a scheduler more easily, several procedures appear in each event. These procedures take the appointment variable (Appointment variable) as parameter. All the details of the appointment handled by the context menu are automatically assigned to this variable.

Example: To store an appointment in a RDV data file, which the user adds via the context menu, simply enter the following in the "Appointment entry output" event:

PROCEDURE SortieDeSaisie(rdvEdité is Appointment)

// Mémorisation des données
RDV.Titre = rdvEdité.Title
RDV.DateDébut = rdvEdité.StartDate
RDV.DateFin = rdvEdité.EndDate
...
HAdd(RDV)

Advanced use of events with procedures

You can also allow the user to define more precisely the characteristics of his appointment during an addition or a modification. To do so, you must create a window or a page with the information to fill.

In the code, simply open the window or page in the "Entry in edit in an appointment" event. To lock the direct input via the context menu of the scheduler, the event must return False.

This principle can be applied to all the events called by the context menu of the Scheduler control.

Example:

PROCEDURE Edition(rdvEdité is Appointment)

// Ouvre la fenêtre de saisie d'un rendez-vous 
// avec le rendez-vous sélectionné (en mode Création ou Modification)
Open(FEN_SaisieRDV_HFSQL, rdvEdité)

// Renvoie FAUX pour bloquer la saisie directe dans le champ Planning
RETURN False

Optional events

Several optional events can be added. To add an optional event:

Select the desired control.
Display the code window of this control (F2 key).
Click the link "Add other events to xxx" at the bottom of the window code, after the last event.
All the optional events available for the control are displayed.
Check the optional event to add and validate.
Note: Several optional events can be selected.
The selected optional event is automatically added to the events managed by the control.

To disable an optional event, simply perform the same operations to display the list of optional events. Then simply uncheck the optional events to delete.
Note: If the deactivated code contains WLanguage code, this code is automatically deleted..

For example, you can use the following events:

the mouse hover over the control,
left mouse button down, up, double click,
right mouse button down, up, double click,
mouse wheel, etc.

For more details, see the Optional events.