PC SOFT

ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Home | Sign in | English EN
  • 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 through programming
  • WLanguage functions
  • WLanguage properties
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
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:
  1. Click in the quick access buttons.
  2. The creation window appears: click "Report" then "Report".
  3. The report creation wizard 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, ...). For more details, see Report data source.

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 in the code via the GranularityGridlines property.
  • The display mode of resources. The resources can be displayed in rows or in columns.
Remark: 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" in the context 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.
    • the display of appointments for the entire day. If the "Show all-day appointments" option is checked, the report supports appointments for which the "WholeDay" property is set to true (for more details, see Appointment variable). In this case, a specific area used to display the daily appointments appears in the schedule:
      Remark: 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 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 is automatically used to display appointments.
        This report can be customized, renamed, etc.
      • 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 through programming

WLanguage functions

Several WLanguage functions are available in the report editor for handling the Scheduler controls. These functions are:
SchedulerAddAppointmentAdds a new appointment into a Scheduler control.
SchedulerAddResourceAdds a new resource into a Scheduler control.
SchedulerChangeModeModifies the period (which means the number of days) displayed by a Scheduler control.
SchedulerBackgroundColorDefines a background color for a time period in a Scheduler control (time period corresponding to lunch time, a public holiday, etc.).
SchedulerTimeDisplayedDefines the time range displayed by the Scheduler control in Day mode or in Week mode.
SchedulerListAppointmentReturns:
  • 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).
SchedulerModeReturns the display mode of a Scheduler control: day, week, month, ...
SchedulerPositionDisplays a Scheduler control from a specified date or returns the date of the first day (or last day) displayed in a Scheduler control.
SchedulerPositionDateTimeDisplays a Scheduler control from a specified date or returns the date of the first day (or last day) displayed in a Scheduler control.
SchedulerDeleteAppointmentDeletes an appointment from a Scheduler control.
SchedulerDeleteResourceDeletes a resource from a Scheduler control.
SchedulerDeleteAllDeletes all appointments and resources from a Scheduler control.

WLanguage properties

Several WLanguage properties are available in the report editor for handling the Scheduler controls. These properties are as follows:
StartDatePeriodDisplayedThe StartDatePeriodDisplayed property is used to get the start date of the time period displayed in a Scheduler or Organizer control of a report.
EndDatePeriodDisplayedThe EndDatePeriodDisplayed property is used to get the end date of the time period displayed in a Scheduler or Organizer control of a report.
GranularityGridlinesThe GranularityGridlines property gets and changes the size of the grid that defines the gridlines in a Scheduler or Organizer control in a report.
HeightThe Height property is used to get and change the height:
  • of a control or block in a report.
  • of a control (in a window), window, row of a Table, List Box or ListView control, option of a Radio Button or Check Box control, break header or footer of a Table or Looper control.
  • of a control (in a page), break header or footer in a Table or Looper control. The control can be overlayable or not.
WidthThe Width property gets and changes 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 overlayable or not.
CaptionPeriodHeaderThe CaptionPeriodHeader property is used to get and change the caption of the time period displayed in the header of a Scheduler or Agenda control in a report.
NameThe Name property is used to get:
  • 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.
FontAppointmentContentThe FontAppointmentContent property 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.
FontAppointmentTitleThe FontAppointmentTitle property is used to:
  • Find out the characteristics of the font used for the title of appointments in the Scheduler and Organizer reports.
  • Modify the characteristics of the font used for the title of appointments in the Scheduler and Organizer reports.
VisibleThe Visible property is used to:
  • Find out whether an element is visible.
  • Make an element visible or invisible.
XThe X property is used to:
  • Get the X-coordinate of a control, Table control column or window (position on the X-axis).
  • Get the X-coordinate of a control or window (position on the X-axis).
YThe Y property 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 version required
  • Version 17
This page is also available for…
Comments
Click [Add] to post a comment