PC SOFT

ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Home | Sign in | English EN
  • Overview
  • Creating an Organizer report
  • Creating the report
  • Information specific to the creation of Agenda report
  • Characteristics of Organizer report and Organizer control
  • Handling an organizer 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 gives you the ability to create "Organizer" reports.
In this case, the report includes an Organizer control only. This type of control is created when creating an Organizer report: it cannot be created independently of the report.
Example:
In the editor, this control includes two blocks:
  • The "Header" block, displaying the titles of the organizer columns.
  • The "Organizer" block, displaying the appointments in an Organizer control.
Creating an Organizer report

Creating the report

To create an "Organizer" report:
  1. Click in the quick access buttons.
    • The creation window appears: click "Report" then "Report".
    • The report creation wizard starts.
  2. Select an "Organizer or Scheduler" report.
  3. In the rest of the wizard, specify:

Information specific to the creation of Agenda report

The information specific to the creation of the Organizer report is:
  • Initial display mode: The organizer can be displayed:
    • on a daily basis,
    • on a weekly basis,
    • on a monthly basis.
  • The granularity of gridlines. This granularity is used to define the size of the grid used to display the gridlines of Organizer 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.
Remark: If the Organizer report is linked to a data source (query, data file), you must specify the items that will be taken into account for displaying the appointments. The following information must be specified:
  • the title of appointment.
  • the start and end dates of appointment.
Characteristics of Organizer report and Organizer control
You have the ability to modify the following characteristics of Organizer report:
  • The data source of Organizer report can be modified in the "Data" tab of the description window of report ("Report description" in the context menu of report).
  • The "General" tab of the description window of Organizer control is used to specify:
    • the initial display mode: Day, week, month.
    • the number of days displayed.
    • the visible time period.
    • the first day of the week.
    • the granularity of gridlines.
    • 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, an area used to display the daily appointments appears in the organizer:
      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 display mask for the date and schedules.
    • 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.
  • If the Organizer control is linked to a data source (data file, query, ...), the "Content" tab found in the description window of the control is used to linked the appointment data with the data found in the data source.
  • The "Style" tab of the Organizer control description window is used to specify the style of the appointments displayed in the Organizer control.
Handling an organizer in a report through programming

WLanguage functions

Several WLanguage functions are available in the report editor for handling the Organizer controls. These functions are:
OrganizerAddAppointmentAdds a new appointment to an Organizer control.
OrganizerChangeModeModifies the time range displayed by an Organizer control (Day/Week/Month).
OrganizerChangeZoomModifies the time range displayed by an Organizer control (Day/Week/Month). This function is kept for backward compatibility.
OrganizerBackgroundColorDefines a background color for a time slot in an Organizer control.
OrganizerTimeDisplayedDefines the time range displayed by the Organizer control in Day mode or in Week mode.
OrganizerListAppointmentReturns:
  • the list of appointments found between two dates in an Organizer control,
  • all appointments found in an Organizer control,
  • a specific appointment (selected or hovered).
OrganizerModeReturns the display mode of an Organizer control: day, week, month, ...
OrganizerPositionDisplays an Organizer control from a specified date or returns the date of the first day (or the date of the last day) displayed in an Organizer control.
OrganizerDeleteAppointmentDeletes an appointment from an Organizer control.
OrganizerDeleteAllDeletes all the appointments from an Organizer control.
OrganizerZoomReturns the time range displayed by an Organizer control.

WLanguage properties

Several WLanguage properties are available in the report editor for handling the Organizer 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.
Minimum version required
  • Version 17
This page is also available for…
Comments
Click [Add] to post a comment