Help / Developing an application or site / Controls, windows and pages / Controls: Available types / Scheduler control
  • Events managed by default
  • Events supported by WINDEV and WINDEV Mobile
  • Events with procedures
  • Advanced use of events with procedure
  • Optional events
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WindowsLinuxPHPWEBDEV - Browser code
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Stored procedures
Events managed by default

Events supported by WINDEV and WINDEV Mobile

WINDEV and WINDEV Mobile manage the following events by default (order of appearance in the code editor):
EventRuntime condition
InitializingRun when the window is opened. *
Before creating the appointmentRun:
  • during the direct input of a new appointment via the keyboard.
AndroidiPhone/iPad 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.
  • 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".
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 appointmentRun when an existing appointment is selected in the Scheduler control.
Moving an appointmentRun when an appointment is moved in the Scheduler control.
AndroidiPhone/iPad 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.
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").
  • when "Delete the appointment" is selected in the context menu of Scheduler control.
  • when an appointment is deleted via the DEL key of keyboard.
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
AndroidiPhone/iPad 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 appointmentRun when moving an appointment triggers the modification of the resource associated with the appointment.
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:
  1. On the "Window" tab, in the "Order" group, click "Initialization".
  2. In the window displayed, use the arrows on the right to modify the order in which the controls are initialized.
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

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.
Optional events
Several optional events are supported. To add an optional event:
  1. Select the desired control.
  2. Display the code window of this control (F2 key).
  3. Click the link "Add other events to xxx" at the bottom of the window code, after the last event.
  4. All the optional events available for the control are displayed.
  5. Check the optional event to add and validate.
    Remark: You can select several optional events.
  6. 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.
Minimum version required
  • Version 16
This page is also available for…
Click [Add] to post a comment

Last update: 05/26/2022

Send a report | Local help