ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

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 with procedures
  • Advanced use of events with procedures
  • Optional events
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
Default events
WINDEV

Events supported by WINDEV and WINDEV Mobile

WINDEV and WINDEV Mobile handle the following events by default (order of appearance in the code editor):
EventRuntime condition
InitializingExecuted when the window is opened. *
Before creating the appointmentRun:
  • WINDEV when "New appointment" is selected in the context menu of Scheduler control.
  • during the direct input of a new appointment via the keyboard.
WINDEV 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.
WINDEV 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 appointmentRun when an existing appointment is selected in the Scheduler control.
Moving an appointmentRun when an appointment is moved in the Scheduler control.
WINDEV This event is run at the end of the movement with the mouse (when the mouse is "released").
Remark: The move performed is canceled if this event runs the following line of code:
RESULT False
WINDEV 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").
WINDEV 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.
WINDEV 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
WINDEV 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).
Reassigning an appointmentRun when moving an appointment triggers the modification of the resource associated with the appointment.
WINDEV 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 "Initialization" event of each control is executed according to the order in which the controls were created in the window. To change this order of execution:
  1. On the "Window" tab, in the "Order" group, click "Initialization".
  2. In the window that appears, use the arrows on the right to change 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 context menu in an APT data file, simply write in the "Exit from input for the appointment" event:
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 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.
WINDEV This principle can be applied to all the events called by the context menu of the Scheduler control.
WINDEV 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:
  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 the following aspects, for example:
  • 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.
Minimum version required
  • Version 16
This page is also available for…
Comments
Click [Add] to post a comment

Last update: 07/03/2023

Send a report | Local help