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 in WEBDEV
  • 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
WEBDEV - Server code

Events supported in WEBDEV

WEBDEV supports the following events by default (order of appearance in the code editor):
EventRuntime condition
Initialization (server code)Executed when the page is opened.
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 "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)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 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.
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