Events associated with a Scheduler control

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

Editors

Controls (window/page/report)

Controls

Scheduler control

Events associated with a Scheduler control

Events managed by default

Events with procedures

Optional events

See also

Events associated with a Scheduler control

Events managed by default

Events supported by WINDEV and WINDEV Mobile

Versions 21 and later

Scheduler controls are available for Android applications.

Scheduler controls are available for iPhone/iPad applications.

New in version 21

Scheduler controls are available for Android applications.

Scheduler controls are available for iPhone/iPad applications.

Scheduler controls are available for Android applications.

Scheduler controls are available for iPhone/iPad applications.

WINDEV and WINDEV Mobile manage the following events by default (order of appearance in the code editor):

Event	Runtime condition

Initializing	Run 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 the Scheduler control: the selected period is highlighted and a "+" sign is displayed. Click the "+" sign: the event "Before creating the appointment" is run. 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 event "Before creating the appointment".
Exit from input for the appointment	Run 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	Run when an existing appointment is selected in the Scheduler control.
Moving an appointment	Run 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"). Versions 22 and later Remark: The move performed is canceled if this event runs the following line of code: RESULT False New in version 22 Remark: The move performed is canceled if this event runs the following line of code: RESULT False Remark: The move performed is canceled if this event runs the following line of code: RESULT False To move an appointment, a long press must be performed: the appointment switches to move mode and it can be moved with the finger toward its destination. This event is run at the end of the move.
Resizing an appointment	Run 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	Run 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	Run 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). Run 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	Run when moving an appointment triggers the modification of the resource associated with the appointment.
Versions 17 and later Whenever changing the display mode New in version 17 Whenever changing the display mode Whenever changing the display mode	Run 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 "Initializing" event of each control is run according to the order in which the controls were created in the window. To modify this order of execution:

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

Events managed by WEBDEV

WEBDEV manages the following events by default (order of appearance in the code editor):

Event	Runtime condition

Initialization (server code)	Run when opening the page.
Moving an appointment (server code)	Run 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)	Run 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)	Run 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)	Run 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)	Run when moving an appointment triggers the modification of the resource associated with the appointment.
Selecting an appointment (browser code)	Run when an existing appointment is selected in the Scheduler control.
Moving an appointment (browser code)	Run 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)	Run 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)	Run when a time range is selected in the Scheduler control.
Deleting an appointment (browser code)	Run 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 event "Before creating the appointment".
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)	Run 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 added by the user via the popup menu in an APT data file, simply write in the event "Exit from input for the appointment":

PROCÉDURE ExitFromInput(aptEdited is Appointment)

// Store the data
APT.Title = aptEdited.Title
APT.StartDate = aptEdited.StartDate
APT.EndDate = aptEdited.EndDate
...
HAdd(APT)

Advanced use of events with procedure

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 event "Entry in edit in an appointment". 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:

PROCÉDURE Edit(aptEdited is Appointment)

// Opens the window for entering an appointment
// with the selected appointment (in Creation or Modification mode)
Open(WIN_InputAPT_HFSQL, aptEdited)

// Returns False to lock the direct input in the Scheduler control
RESULT False

Optional events

Several optional events are supported. 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.
Remark: You can select several optional events.
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.
Remark: If the disabled code contains WLanguage code, this code is automatically deleted.

You can manage, for example:

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

For more details, see the Optional events.