PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US
  • Overview
  • Creating a Scheduler report
  • Creating the report
  • Information specific to the creation of the Scheduler
  • Characteristics of a Scheduler report and Scheduler control
  • Characteristics of the Scheduler (report editor)
  • Handling a schedule in a report by programming
  • WLanguage functions
  • WLanguage properties
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
Overview
The report editor allows you to create "Scheduler" reports.
In this case, the report contains a Scheduler control only. This type of control is created when creating a Scheduler report: it cannot be created independently of this report.
Example:
In the editor, this control includes two blocks:
  • The "Header" block that displays the titles of the columns found in the schedule.
  • The "Schedule" block that displays the resources and the appointments in a Scheduler control.
Creating a Scheduler report

Creating the report

To create a "Scheduler" report, select "File .. New .. Report .. Schedule". The wizard for report creation starts. In this wizard, you must specify:
  • the template used if necessary,
  • the data source of the report (data file, query, Scheduler control, ...). See Data source of report for more details.
  • the information specific to the creation of the Schedule.
To create a "Scheduler" report, select "File .. New .. Report .. Organizer or Scheduler". The wizard for report creation starts. In this wizard, you must specify:
  • the type of report to create ("Scheduler report") with the information specific to the creation of a scheduler control:
    • the number of days to display.
    • the granularity of gridlines.
    • the display mode of resources (ressources displayed in rows or in columns).
  • the template used if necessary,
  • the data source of the report (data file, query, Scheduler control, ...). See Data source of report for more details.
To create a "Scheduler" report:
  1. Click among the quick access buttons.
  2. Click "Report" in the wheel that is displayed. The window for creating a new element is displayed: click "Report" then "Report".
  3. The wizard for report creation starts.
  4. In this wizard, specify:
    • the type of report to create ("Scheduler report") with the information specific to the creation of a scheduler control:
      • the number of days to display.
      • the granularity of gridlines.
      • the display mode of resources (ressources displayed in rows or in columns).
    • the template used if necessary,
    • the data source of the report (data file, query, Scheduler control, ...). See Data source of report for more details.

Information specific to the creation of the Scheduler

The following information is specific to the creation of the Scheduler control:
  • Number of days to display in the Scheduler control: The schedule can be printed:
    • for a day,
    • for a week on 5 days,
    • for a week on 7 days,
    • for a month,
    • from the first appointment to the last one,
    • with a custom number of days.
  • The granularity of gridlines. This granularity is used to define the size of the grid used to display the gridlines of the Scheduler control. This granularity is set to 30 minutes by default. This information must be modified according to the number of days to display.
    This characteristic can be modified by programming via ..GranularityGridlines.
  • The display mode of resources. The resources can be displayed in rows or in columns.
Note: If the Scheduler report is linked to a data source (query, data file), you must specify the items that will be taken into account for displaying the schedule and the appointments. The following information must be specified:
  • the title of appointment
  • the resource associated with the appointment
  • the start and end dates of appointment
Characteristics of a Scheduler report and Scheduler control

Characteristics of the Scheduler (report editor)

You have the ability to modify the following characteristics of a Scheduler report:
  • The data source of the Scheduler report can be modified in the "Data" tab of the description window of the report ("Report description" from the popup menu of the report).
  • The "General" tab in the description window of Scheduler control is used to specify:
    • the number of days that must be displayed in the control.
    • the granularity of gridlines.
    • the visible time period.
    • Versions 18 and later
      the display of appointments for the entire day. It the option "Display the appointments for the entire day" is checked, the report takes into account the appointments for which the "Whole day" characteristic is supported (see Appointment variable for more details). In this case, a specific area used to display the daily appointments appears in the schedule:
      Note: Make sure that the area used to display the daily appointments has the proper dimensions in the report editor. It can be resized if necessary.
      New in version 18
      the display of appointments for the entire day. It the option "Display the appointments for the entire day" is checked, the report takes into account the appointments for which the "Whole day" characteristic is supported (see Appointment variable for more details). In this case, a specific area used to display the daily appointments appears in the schedule:
      Note: Make sure that the area used to display the daily appointments has the proper dimensions in the report editor. It can be resized if necessary.
      the display of appointments for the entire day. It the option "Display the appointments for the entire day" is checked, the report takes into account the appointments for which the "Whole day" characteristic is supported (see Appointment variable for more details). In this case, a specific area used to display the daily appointments appears in the schedule:
      Note: Make sure that the area used to display the daily appointments has the proper dimensions in the report editor. It can be resized if necessary.
    • Versions 20 and later
      the custom report to display the appointments.
      • If the selected option is "None", the default display is used.
      • If "Preset report" is selected, a preset report is automatically added to the project. This report is named "RPT_WinDevViewAPT" by default and it is automatically used to display the appointments.
        This report can be customized, renamed, ...
      • If the selected option corresponds to a project report, this report will be used to display the appointments.
        We advise you to customize the report proposed by default.
        The same report can be used to customize the appointments in a Scheduler or Organizer report.
      New in version 20
      the custom report to display the appointments.
      • If the selected option is "None", the default display is used.
      • If "Preset report" is selected, a preset report is automatically added to the project. This report is named "RPT_WinDevViewAPT" by default and it is automatically used to display the appointments.
        This report can be customized, renamed, ...
      • If the selected option corresponds to a project report, this report will be used to display the appointments.
        We advise you to customize the report proposed by default.
        The same report can be used to customize the appointments in a Scheduler or Organizer report.
      the custom report to display the appointments.
      • If the selected option is "None", the default display is used.
      • If "Preset report" is selected, a preset report is automatically added to the project. This report is named "RPT_WinDevViewAPT" by default and it is automatically used to display the appointments.
        This report can be customized, renamed, ...
      • If the selected option corresponds to a project report, this report will be used to display the appointments.
        We advise you to customize the report proposed by default.
        The same report can be used to customize the appointments in a Scheduler or Organizer report.
    • the display mode of resources: in rows or in columns. If the resources are displayed in columns, you have the ability to specify the number of resources displayed in columns.
    • the display mask for the dates and times.
  • If the Scheduler control is linked to a data source (data file, query, ...), the "Content" tab found in the description window of the control is used to link the appointment data with the data found in the data source.
  • The "Style" tab in the description window of the Scheduler control is used to specify the style:
    • for the caption of resources.
    • for the appointments displayed in the Scheduler control.
Handling a schedule in a report by programming

WLanguage functions

Several WLanguage functions are available in the report editor for handling the Scheduler controls. These functions are as follows:
Versions 16 and later
SchedulerAddAppointment
New in version 16
SchedulerAddAppointment
SchedulerAddAppointment
Adds a new appointment into a Scheduler control.
Versions 16 and later
SchedulerAddResource
New in version 16
SchedulerAddResource
SchedulerAddResource
Adds a new resource into a Scheduler control.
Versions 17 and later
SchedulerBackgroundColor
New in version 17
SchedulerBackgroundColor
SchedulerBackgroundColor
Defines a background color for a time period in a Scheduler control.
Versions 16 and later
SchedulerChangeMode
New in version 16
SchedulerChangeMode
SchedulerChangeMode
Modifies the period (which means the number of days) displayed by a Scheduler control.
Versions 16 and later
SchedulerDeleteAll
New in version 16
SchedulerDeleteAll
SchedulerDeleteAll
Deletes all the appointments and all the resources from a Scheduler control.
Versions 16 and later
SchedulerDeleteAppointment
SchedulerDeleteAppointment
Deletes an appointment from a Scheduler control.
Versions 16 and later
SchedulerDeleteResource
New in version 16
SchedulerDeleteResource
SchedulerDeleteResource
Deletes a resource from a Scheduler control.
Versions 16 and later
SchedulerListAppointment
New in version 16
SchedulerListAppointment
SchedulerListAppointment
Returns:
  • the list of appointments found between two dates in a Scheduler control,
  • all the appointments found in a Scheduler control,
  • a specific appointment (selected or hovered).
Versions 17 and later
SchedulerMode
New in version 17
SchedulerMode
SchedulerMode
Returns the display mode of a Scheduler control: day, week, month, ...
Versions 16 and later
SchedulerPosition
New in version 16
SchedulerPosition
SchedulerPosition
Displays a Scheduler control from a specified date or returns the date of the first day (or last day) displayed in a Scheduler control.
Versions 17 and later
SchedulerPositionDateTime
New in version 17
SchedulerPositionDateTime
SchedulerPositionDateTime
Displays a Scheduler control from a specified date or returns the date of the first day (or last day) displayed in a Scheduler control.
Versions 16 and later
SchedulerTimeDisplayed
New in version 16
SchedulerTimeDisplayed
SchedulerTimeDisplayed
Defines the time range displayed by the Scheduler control in Day mode or in Week mode.

WLanguage properties

Several WLanguage properties are available in the report editor for handling the Scheduler controls. These properties are as follows:
Versions 17 and later
CaptionPeriodHeader
New in version 17
CaptionPeriodHeader
CaptionPeriodHeader
..CaptionPeriodHeader is used to find out and modify the content of the period caption displayed in the header of a Scheduler or Organizer control found in a report
Versions 17 and later
EndDatePeriodDisplayed
New in version 17
EndDatePeriodDisplayed
EndDatePeriodDisplayed
..EndDatePeriodDisplayed is used to find out the end date of the period currently printed in a Scheduler control or in an Organizer control found in a report
Versions 18 and later
FontAppointmentContent
New in version 18
FontAppointmentContent
FontAppointmentContent
..FontAppointmentContent is used to:
  • Find out the characteristics of the font used for the content of appointments in the Scheduler and Organizer reports.
  • Modify the characteristics of the font used for the content of appointments in the Scheduler and Organizer reports.
Versions 18 and later
FontAppointmentTitle
New in version 18
FontAppointmentTitle
FontAppointmentTitle
..FontAppointmentTitle is used to:
  • Find out the characteristics of the font used for the title of the appointments in the Scheduler and Organizer reports.
  • Modify the characteristics of the font used for the title of the appointments in the Scheduler and Organizer reports.
Versions 17 and later
GranularityGridlines
New in version 17
GranularityGridlines
GranularityGridlines
..GranularityGridlines allows you to find out and modify the size of the grid used to display the gridlines in a Scheduler control or in an Organizer control found in a report.
Versions 09 and later
Height
New in version 09
Height
Height
..Height is used to find out and modify the height:
  • of a control or block in a report.
  • of a control (found in a window), window, row found in a table, in a list box or in a listview, option found in a radio button or in a check box, break header or break footer found in a table or in a looper.
  • of a control (found in a page), break header or break footer found in a table or in a looper. The control can be stackable or not.
Versions 09 and later
Name
New in version 09
Name
Name
..Name is used to find out:
  • the name of the font associated with a Font variable.
  • the name of a control, report or report block.
  • the name of a control, group of controls or window.
  • the name of a control, group of controls or page.
Versions 17 and later
StartDatePeriodDisplayed
New in version 17
StartDatePeriodDisplayed
StartDatePeriodDisplayed
..StartDatePeriodDisplayed is used to find out the start date of the period currently printed in a Scheduler or Organizer control found in a report
Versions 09 and later
Visible
New in version 09
Visible
Visible
..Visible is used to:
  • Find out whether an element is visible.
  • Make an element visible or invisible.
Versions 09 and later
Width
New in version 09
Width
Width
..Width is used to find out and modify the width:
  • of a control or block in a report.
  • of a control (found in a window), window, column found in a table or column found in a list box (including listview).
  • of a control (found in a page), column found in a table or column found in a list box. The control can be stackable or not.
Versions 09 and later
X
New in version 09
X
X
..X is used to:
  • Find out the X coordinate of a control, of a Table control column or of a window (position on X axis).
  • Modify the X coordinate of a control or window (position on X axis).
Versions 09 and later
Y
New in version 09
Y
Y
..Y is used to:
  • Find out the Y coordinate of a control or window (position on Y axis).
  • Modify the Y coordinate of a control or window.
Related Examples:
WD Reports Training (WINDEV): WD Reports
[ + ] This example presents the different methods for creating a report:

- prints based on different data sources (queries, variables, ...)
- prints based on controls (Table, Spreadsheet, PVT, ...)
- printing composite reports
- specific prints (portrait/landscape, report with watermark, report with bar code, ...)
Minimum required version
  • Version 17
This page is also available for…
Comments
Click [Add] to post a comment