The Scheduler control

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | Français

Help

Editors

Controls (window/page/report)

Controls

Scheduler control

The Scheduler control

Overview

Creating a Scheduler control (window and page editor)

Describing a scheduler (window and page editor)

Related examples

See also

The Scheduler control

Overview

Control found in a window, page or report

The Scheduler control is used to automatically display and handle schedules. It is used to manage the display of multiple resources and it is used in several applications or sites.

The display is performed:

on a daily, weekly or montly basis,
Versions 22 and later
on 6 months or on 1 year.
New in version 22
on 6 months or on 1 year.
on 6 months or on 1 year.

The time period, the first day of the week and the number of days to display can be configured. These parameters can be easily defined from the description window of the control.

Notes:

A Scheduler control can be anchored:
- via the anchoring options of WINDEV and WINDEV Mobile.
Versions 17 and later
The Scheduler controls are available in the Scheduler reports. See Scheduler report for more details.
New in version 17
The Scheduler controls are available in the Scheduler reports. See Scheduler report for more details.
The Scheduler controls are available in the Scheduler reports. See Scheduler report for more details.
The Scheduler control is available in Linux in the pages of Linux WEBDEV sites only. The Scheduler control is not available in the windows of WINDEV applications for Linux.

Creating a Scheduler control (window and page editor)

To create a Scheduler control:

In the window or page editor, click (or select "Insert .. Control .. Scheduler control").On the "Creation" pane, in the "Graphic controls" group, expand "Time" and select "Scheduler".
Click the position where the control will be created in the window or page.
The wizard for creating the Scheduler control starts. Answer the questions and validate.
The control appears in creation mode.

Versions 20 and later
Note: The dimensions of created control are optimized in order to occupy the available space at the specified position. If the control size does not suit you, press Ctrl + Z: the default control size will be restored.

New in version 20
Note: The dimensions of created control are optimized in order to occupy the available space at the specified position. If the control size does not suit you, press Ctrl + Z: the default control size will be restored.

Note: The dimensions of created control are optimized in order to occupy the available space at the specified position. If the control size does not suit you, press Ctrl + Z: the default control size will be restored.

To display the control characteristics, select "Description" from the popup menu of control.

Note: A Scheduler control can be anchored:

via the anchoring options of WINDEV and WINDEV Mobile.

Describing a scheduler (window and page editor)

The control options (window editor and page editor)

The Scheduler control can be customized in the editor via the description window ("Details" tab for WINDEV and "General" tab for WEBDEV).The Scheduler control can be customized in the editor via the description window ("Details" tab).

The parameters of the Scheduler control are as follows:

With buttons for changing period: This option is used to display buttons in order for the user to scroll the different periods of the schedule. These buttons are displayed at the top left of schedule.
Number of days to display: By default, the display is performed on a monthly basis but a schedule can also be displayed on a daily basis, on a weekly basis (on 5 or 7 days), according to the number of appointments or according to a specified number of days.
This display mode can be modified by the user via the popup menu of the control.
Versions 22 and later
Display: By default, the display is performed on a monthly basis with a granularity for move and duration set to one day. When clicking the display options, a window is opened, allowing you to define the different display options:
It is possible to define the following elements:
- Total schedule range: day, week (5 or 7 days), according to the number of appointments, according to the number of days, 6 months, one year.
- Granularity of appointments: Corresponds the display precision of schedule. The appointments can start on a multiple of XX minutes, hours, ... and they can have a duration multiple of XX minutes, hours, ... The arrow button is used to enter preset values. The lock is used to link (or not) the values.
- Range viewed: The range viewed is calculated from the control size in the editor. By entering the range to view, you get the minimum dimension of the element according to the selected unit.
- When validating this window, the selected characteristics are summarized in the description window of control.
New in version 22
Display: By default, the display is performed on a monthly basis with a granularity for move and duration set to one day. When clicking the display options, a window is opened, allowing you to define the different display options:
It is possible to define the following elements:
- Total schedule range: day, week (5 or 7 days), according to the number of appointments, according to the number of days, 6 months, one year.
- Granularity of appointments: Corresponds the display precision of schedule. The appointments can start on a multiple of XX minutes, hours, ... and they can have a duration multiple of XX minutes, hours, ... The arrow button is used to enter preset values. The lock is used to link (or not) the values.
- Range viewed: The range viewed is calculated from the control size in the editor. By entering the range to view, you get the minimum dimension of the element according to the selected unit.
- When validating this window, the selected characteristics are summarized in the description window of control.
Display: By default, the display is performed on a monthly basis with a granularity for move and duration set to one day. When clicking the display options, a window is opened, allowing you to define the different display options:
It is possible to define the following elements:
- Total schedule range: day, week (5 or 7 days), according to the number of appointments, according to the number of days, 6 months, one year.
- Granularity of appointments: Corresponds the display precision of schedule. The appointments can start on a multiple of XX minutes, hours, ... and they can have a duration multiple of XX minutes, hours, ... The arrow button is used to enter preset values. The lock is used to link (or not) the values.
- Range viewed: The range viewed is calculated from the control size in the editor. By entering the range to view, you get the minimum dimension of the element according to the selected unit.
- When validating this window, the selected characteristics are summarized in the description window of control.
Display mode of resources: The resources are displayed in row by default.
You also have the ability to display them in column.
Display masks: Used to define: Time display: Used to define:
- the format of the date displayed for the "day" columns (or rows) of the scheduler.
- Versions 19 and later
  whether the time must be displayed or not in the control.
  New in version 19
  whether the time must be displayed or not in the control.
  whether the time must be displayed or not in the control.
- the format of the time displayed for the "day" columns (or rows) of scheduler.
- Versions 17 and later
  whether the week number must be displayed or not, as well as its format. In the format, the '%1' string corresponds to the week number. Example of format: "Wk. %1".
  New in version 17
  whether the week number must be displayed or not, as well as its format. In the format, the '%1' string corresponds to the week number. Example of format: "Wk. %1".
  whether the week number must be displayed or not, as well as its format. In the format, the '%1' string corresponds to the week number. Example of format: "Wk. %1".
Time period: Used to define:
- the visible time period: Time period that will be displayed in the control.
- the working time period: Time period for which an appointment can be defined.
Versions 22 and later
To define specific time slots, use SchedulerWorkingHour and SchedulerWorkingHourResource.
New in version 22
To define specific time slots, use SchedulerWorkingHour and SchedulerWorkingHourResource.
To define specific time slots, use SchedulerWorkingHour and SchedulerWorkingHourResource.
Appointments: Used to specify the characteristics of appointments:
- Overlaying: Manage the overlap of appointments. The appointments can be displayed side by side or slightly shifted.
- Granularity of appointments: Precision for displaying the schedule. By default, the granularity is set to 30 minutes.
  You can define:
  - the granularity regarding the move of an appointment.
  - the granularity of the appointment duration, which means the minimum duration of an appointment. Caution: by default, this duration is set to 24 hours.
- Versions 22 and later
  Continuous display if several days: Used to display an appointment over several days as a single appointment. If this option is unchecked, the appointments on several days will correspond to as many appointments as the number of days.
  New in version 22
  Continuous display if several days: Used to display an appointment over several days as a single appointment. If this option is unchecked, the appointments on several days will correspond to as many appointments as the number of days.
  Continuous display if several days: Used to display an appointment over several days as a single appointment. If this option is unchecked, the appointments on several days will correspond to as many appointments as the number of days.
Other parameters:
- Allow range selection: Allows the user to select a period with the mouse.
- Allow the direct input of an appointment: Allows the user to add an appointment directly.
  To do so, click the Scheduler control to create the appointment and enter its caption via the keyboard.
- Versions 18 and later
  Display and allow the appointments for the entire day: Used to specify that an appointment can correspond to a whole day. In this case, a specific area is displayed in the Scheduler control. This area is used to enter the daily appointments.
  You have the ability to specify the height of area.
  Examples:
  - if the schedule is displayed with the resources in row:
    In WINDEV:
  - if the schedule is displayed with the resources in column:
    In WINDEV:
  New in version 18
  Display and allow the appointments for the entire day: Used to specify that an appointment can correspond to a whole day. In this case, a specific area is displayed in the Scheduler control. This area is used to enter the daily appointments.
  You have the ability to specify the height of area.
  Examples:
  - if the schedule is displayed with the resources in row:
    In WINDEV:
  - if the schedule is displayed with the resources in column:
    In WINDEV:
  Display and allow the appointments for the entire day: Used to specify that an appointment can correspond to a whole day. In this case, a specific area is displayed in the Scheduler control. This area is used to enter the daily appointments.
  You have the ability to specify the height of area.
  Examples:
  - if the schedule is displayed with the resources in row:
    In WINDEV:
  - if the schedule is displayed with the resources in column:
    In WINDEV:

The edit options via the mouse are as follows:

Modify duration. You can allow (or not) the user to modify the appointment duration.
Move. You can allow (or not) the user to move an appointment.
Versions 19 and later
Allow the user to change resource. If this option is checked, when moving an appointment, the user will be able to associate it with a different resource.
New in version 19
Allow the user to change resource. If this option is checked, when moving an appointment, the user will be able to associate it with a different resource.
Allow the user to change resource. If this option is checked, when moving an appointment, the user will be able to associate it with a different resource.
Versions 17 and later
Allow the user to overlap. If this option is checked, when moving appointments, the user will be able to make them overlap. In this case, the options defined for overlapping appointments (offset or side by side) will be taken into account.
New in version 17
Allow the user to overlap. If this option is checked, when moving appointments, the user will be able to make them overlap. In this case, the options defined for overlapping appointments (offset or side by side) will be taken into account.
Allow the user to overlap. If this option is checked, when moving appointments, the user will be able to make them overlap. In this case, the options defined for overlapping appointments (offset or side by side) will be taken into account.

The options regarding the dimension of areas are as follows:

if the resources are displayed in row:
- Minimum width of day.
- Minimum height of a resource.
- Width of resource header.
if the resources are displayed in column:
- Minimum width of resource.
- Minimum height of a day.
- Height of the break (for changing day)

Versions 17 and later

Most of these parameters can be modified by programming. See Properties associated with the Scheduler control for more details.

New in version 17

Most of these parameters can be modified by programming. See Properties associated with the Scheduler control for more details.

The options regarding the dimension of areas are as follows:

if the resources are displayed in row:
- Minimum height of a resource.
- Width of resource header.
if the resources are displayed in column:
- Minimum width of resource.
- Height of the break (for changing day)

Most of these parameters can be modified by programming. See Properties associated with the Scheduler control for more details.

A popup menu automatically proposed

The Scheduler control can display a specific popup menu proposing automatic features to the user. This menu is proposed by the AAF (Automatic Application Features).

As soon as at least one resource is found in the schedule, this menu allows the user to:

Modifying the display mode of the scheduler: daily, weekly, monthly display or display of the current day only.
Add, delete or modify an appointment when selecting a time period.
Copy the content of an appointment.
Versions 17 and later
Print the content of Scheduler control.
New in version 17
Print the content of Scheduler control.
Print the content of Scheduler control.

See Automatic features of Scheduler control for more details.

Customize the appointment area

In the Scheduler control, the appointment is displayed in a specific area. You have the ability to translate and customize this area: color of title, background color of the appointment, ...

Versions 17 and later
To modify the aspect of the appointments proposed by default, you have the ability to modify the style options defined for this element.

Display the description window of Scheduler control.
In the "Style" tab, select the "Appointments" element and modify the requested characteristics. You can:
- use a shadow,
- use a separator in dots between hours,
1. use a gradient color,
  - define the fonts used, ...
In the "Style" tab, select the "Appointments" element. You can:
- use a shadow,
- use a separator in dots between hours,
- define the title and background options:
  - solid background,
  - gradient background,
  - Versions 22 and later
    Solid background, multiline title and bottom line. This option is used to display the title on several lines (especially if the appointment is not wide enough to display the entire title)).
    New in version 22
    Solid background, multiline title and bottom line. This option is used to display the title on several lines (especially if the appointment is not wide enough to display the entire title)).
    Solid background, multiline title and bottom line. This option is used to display the title on several lines (especially if the appointment is not wide enough to display the entire title)).
- define the fonts used, ...

New in version 17
To modify the aspect of the appointments proposed by default, you have the ability to modify the style options defined for this element.

Display the description window of Scheduler control.
In the "Style" tab, select the "Appointments" element and modify the requested characteristics. You can:
- use a shadow,
- use a separator in dots between hours,
1. use a gradient color,
  - define the fonts used, ...
In the "Style" tab, select the "Appointments" element. You can:
- use a shadow,
- use a separator in dots between hours,
- define the title and background options:
  - solid background,
  - gradient background,
  - Versions 22 and later
    Solid background, multiline title and bottom line. This option is used to display the title on several lines (especially if the appointment is not wide enough to display the entire title)).
    New in version 22
    Solid background, multiline title and bottom line. This option is used to display the title on several lines (especially if the appointment is not wide enough to display the entire title)).
    Solid background, multiline title and bottom line. This option is used to display the title on several lines (especially if the appointment is not wide enough to display the entire title)).
- define the fonts used, ...

To modify the aspect of the appointments proposed by default, you have the ability to modify the style options defined for this element.

Display the description window of Scheduler control.
In the "Style" tab, select the "Appointments" element and modify the requested characteristics. You can:
- use a shadow,
- use a separator in dots between hours,
1. use a gradient color,
  - define the fonts used, ...
In the "Style" tab, select the "Appointments" element. You can:
- use a shadow,
- use a separator in dots between hours,
- define the title and background options:
  - solid background,
  - gradient background,
  - Versions 22 and later
    Solid background, multiline title and bottom line. This option is used to display the title on several lines (especially if the appointment is not wide enough to display the entire title)).
    New in version 22
    Solid background, multiline title and bottom line. This option is used to display the title on several lines (especially if the appointment is not wide enough to display the entire title)).
    Solid background, multiline title and bottom line. This option is used to display the title on several lines (especially if the appointment is not wide enough to display the entire title)).
- define the fonts used, ...

To customize the display of appointments:

Display the description window of Scheduler control.
In the "General" tab, select the internal window used for the appointments:
- "None": the default display will be used.
- "Preset window": a preset window is automatically added to the project.
  By default, this window is named "IW_WinDevViewAPT.wdw".
The internal window is available in the project explorer. It can be modified in the window editor.
Caution: this internal window can only be used to customize the drawing regarding the display of appointments. Only the "Global declarations" event is executed. No other events are executed. Therefore, you cannot add buttons with a specific click code.

Notes:

You also have the ability to use any internal window of your project.
If you are using the suggested preset window, the style options of the appointment (selected in the "Style" tag) are applied.

Modes for filling a Scheduler control

A Scheduler control can be filled:

Related Examples:

Complete examples (WINDEV): WD Schedule

[ + ] This example presents the management of a graphic schedule.

The following topics are presented in this example:
1/ the scheduler control
2/ the Google Calendar functions

Unit examples (WEBDEV): The Scheduler control

[ + ] This example explains how to use the Scheduler control. Two uses are presented:
- Filling the schedule by programming,
- Filling the schedule by databinding from a code variable.

Complete examples (WEBDEV): WW_Schedule

[ + ] This example is used to dynamically display the tasks of the different contributors.
You have the ability to add, modify or delete tasks by clicking the schedule elements.
All the operations are performed via AJAX.
This example is also used to move a control by programming.