Versions 18 and later

This feature is now available for iPhone/iPad applications.

New in version 18

This feature is now available for iPhone/iPad applications.

This feature is now available for iPhone/iPad applications.

Versions 21 and later

This feature is now available in Universal Windows 10 App mode.

New in version 21

This feature is now available in Universal Windows 10 App mode.

This feature is now available in Universal Windows 10 App mode.

Versions 25 and later

This feature is now available for Android applications.

New in version 25

This feature is now available for Android applications.

This feature is now available for Android applications.

Characteristics of a report on a data file
The characteristics of a report on data file are as follows:

• Search key: a report on a data file is using a search key. This key is used to browse the records that will be printed in the report. This key is defined in the data file.
• Bounded report: a report on a data file can be bounded. These bounds are used to define the range of records that will be printed in the report. See Bounded report based on a data file for more details.

The creation of a report on a data file is performed by the wizard for report creation. This type of report can be created only if the current project is associated with an analysis.

Once the report on a data file is created, you can:

• modify the data source of report ("Data" tab in the report description).
• modify the search key ("Data" tab in the report description).
• define the bounds ("Data" tab in the report description).
• add or delete Item controls linked to the data file associated with the report.

	Important	The data files and the file items that can be used in the reports created with Reports & Queries are defined by the developer in the data model editor of WINDEV. See Preparing a WINDEV application in order to use it with Reports & Queries for more details.

This help page presents:

• How to create a report on a data file.
• The characteristics of a bounded report on a data file.
• How to print a report on a data file by programming.
  • General case.
  • Case of a bounded report.
  • Case of a report with parameters.
  • Case of a bounded report with parameters.

1. Click among the quick access buttons.
   • The element creation window appears: click "Report" then "Report".
   • The wizard for report creation starts.
2. Choose the layout of your report (table, form, label, ...). See The different types of reports for more details.
3. Select (if necessary) the report template to use. A report template is used to comply with a specific page layout. See The report templates for more details.
4. Select the data source of report: "from a data file or from an existing query" option.
5. Select the data file on which the report is based. The description of this data file must be in the analysis associated with the current project.
6. Select the search key of this report. This item will be used to browse the records of the selected data file.
   For a bounded browse, specify the values of the bounds that will be given to the report.
7. Select the sort items for the report. These items will be used to sort the data printed in the report. For more details on sorts, see Sorts in a report.
8. To group the records, you have the ability to create breaks on the sort items. To create breaks, answer "Yes" to the question "Do you want to add some breaks into the report?".
   The next step is used to select the sort items corresponding to the breaks. For more details on breaks, see Breaks in a report.
9. For each data file item displayed in the report:
   • type the corresponding caption. This caption will be displayed:
     • before the item. For example:
       
     • in the column header (for the Table reports). For example:
       
       This caption can be modified in the report editor.
   • select the block where the control associated with the item will be printed. The positions of different controls can be modified in the report editor. See Report blocks for more details.
10. Modify (if necessary) the display order of controls in the report with the arrow buttons found on the right of table.
11. If the data file associated with the report contains at least one numeric item, some calculations can be performed on these items. Specify the calculation performed for each item (sum, average, ...). Two types of calculations are available:
    • general calculation: a Calculated control will be created in the End of document block.
    • calculation on break: a Calculated control will be created in the Break footer block. In the calculations on break, the result of the calculation is reinitialized after each break. To perform a calculation on break, a break must be found in the report currently created.
12. Depending on the type of report currently created, indicate the specific options.
    

    Type of report	Specific options
    Report on form	Form image, printing the form image, ... Options presented in details in Report on form
    Label report	Format of labels, number of identical copies, ... Options presented in details in Label report

13. Specify the format of sheet on which the report will be printed. The report is printed in A4 format by default.
    Remark: By default, the report controls are displayed in a single column. To create a multi-column report, simply specify the desired number of columns in the "Format" tab of the report description window.
14. Select the skin template of the report if necessary.
15. Type the name and title of the report (name of ".WDE" file corresponding to the report). This name will be used to identify the report in your programs.
    You also have the ability to specify whether the report can be modified by the end user in "Reports & Queries".
16. Validate the report creation.
17. The report editor automatically proposes to change the report format if the following conditions are fulfilled:
    • the report currently created includes a table.
    • the report format does not allow to display all table columns.
18. Specify (if necessary) the mode for reducing the report size:
    • Versions 19 and later
      Print the report on several pages. In this case, the end user will have to group the pages. See Multi-page print for more details.
      New in version 19
      Print the report on several pages. In this case, the end user will have to group the pages. See Multi-page print for more details.
      Print the report on several pages. In this case, the end user will have to group the pages. See Multi-page print for more details.
    • Use the landscape mode.
    • Reduce the report size. Caution: according to the reduction percentage, the printed report may become unreadable.
19. The report currently created is displayed in the report editor.

• when creating the report.
• in the report description directly ("Data" tab).

Defining a bounded report

1. Select:
   • "Minimum value provided" and/or "Maximum value provided" when creating the report.
   • "Lower bound" and/or "Upper bound" in the "Data" tab of the report description ("Report description" from the popup menu of the report).
2. Specify the lower bound and/or the upper bound when printing the report with iPrintReport, or with ..MinValue and ..MaxValue. See Printing a bounded report for more details.

Remark: When testing a bounded report ( among the quick access buttons), a window allows you to enter the bounds of the report.

1. Configure the report print destination:
   • In WINDEV, with iDestination (report viewer, print in an HTML file, etc.).
   • In WEBDEV, with iDestination (print in an HTML file, ...).
   • In Android and iOS, with iDestination (print in a PDF file).
   • In Windows Mobile, with iConfigure or iParameter. These functions open a dialog box allowing the user to select the default printer.
     See Print modes of a report for more details.
2. Specify the name of the report to print with iPrintReport.

• Printing a bounded report based on a data file.
• Printing a report with parameters based on a data file.
• Printing a bounded report with parameters based on a data file.

	Important	In Reports & Queries, a report can be printed: by starting a print ( ). by running the report test ( ). Therefore, no programming is required to print the report.

WINDEV and WINDEV Mobile examples The "RPT_Customer" report is based on the "Customer" data file. This report is used to print the characteristics of customers.

"RPT_Customer" is printed during when "BTN_Customer" is clicked on. In this example, the click code of "BTN_Customer" is as follows:

• WINDEV code:
  
  // Open the report viewer
  iDestination(iViewer)
  // Prints the RPT_Customer report
  iPrintReport(RPT_Customer)
  
• Windows Mobile code:
  
  // Select the printer
  iConfigure()
  // Prints the RPT_Customer report
  iPrintReport(RPT_Customer)
  
• Android/iOS code:
  
  // Configures the print destination
  iDestination(iPDF)
  // Prints the RPT_Customer report
  iPrintReport(RPT_Customer)
  

WEBDEV example The "RPT_Customer" report is based on the "Customer" data file. This report is used to print the characteristics of customers.

The "RPT_Customer" report is displayed in a PDF file when clicking the "LINK_Customer" link. Then, the PDF file is displayed in the browser. In this example, the server click code of the "LINK_Customer" link is as follows:

// Generates a unique PDF file name
UniqueFileName is string = fWebDir() + "\" + "RPT_Customer_" + ...
DateSys() + TimeSys() + ".pdf"
// Configures the print destination
iDestination(iPDF, UniqueFileName)
// Prints the RPT_Customer report
iPrintReport(RPT_Customer)
// Sends the file to the browser
FileDisplay(UniqueFileName, "application/pdf")
// Deletes the file
fDelete(UniqueFileName)

Printing a bounded report based on a data file

To print a bounded report based on a data file, you must:

1. Configure the report print destination:
   • In WINDEV, with iDestination (report viewer, print in an HTML file, etc.).
   • In WEBDEV, with iDestination (print in an HTML file, ...).
   • In Android and iOS, with iDestination (print in a PDF file).
   • In Windows Mobile, with iConfigure or iParameter. These functions open a dialog box allowing the user to select the default printer.
     See Print modes of a report for more details.
2. Specify the following parameters via iPrintReport:
   • the name of the report to print.
   • the value of the lower bound for the report.
   • the value of the upper bound for the report.

WINDEV and WINDEV Mobile example

The "RPT_Customer" report is a bounded report based on the "Customer" data file. This report is used to print the characteristics of the customers whose name starts with the letter "D".

The lower bound corresponds to "D". The upper bound corresponds to "D"+hMaxVal.

"RPT_Customer" is printed during when "BTN_CustomerD" is clicked on.

In this example, the click code of "BTN_CustomerD" is as follows:

• WINDEV code:
  
  // Open the report viewer
  iDestination(iViewer)
  // Prints the RPT_Customer report
  iPrintReport(RPT_Customer, "D", "D" + hMaxVal)
  
• Windows Mobile code:
  
  // Select the printer
  iConfigure()
  // Prints the RPT_Customer report
  iPrintReport(RPT_Customer, "D", "D" + hMaxVal)
  
• Android/iOS code:
  
  // Configures the print destination
  iDestination(iPDF)
  // Prints the RPT_Customer report
  iPrintReport(RPT_Customer, "D", "D" + hMaxVal)
  

WEBDEV example The "RPT_Customer" report is a bounded report based on the "Customer" data file. This report is used to print the characteristics of the customers whose name starts with the letter "D". The lower bound corresponds to "D". The upper bound corresponds to "D"+hMaxVal. "RPT_Customer" is printed in an HTML file and sent to the browser when "BTN_CustomerD" is clicked on.

In this example, the click code of the Button control "CustomerD" is as follows:

// Generates a unique file name
UniqueFileName is string = fWebDir() + "\" + "RPT_Customer_" + ...
DateSys() + TimeSys() + ".pdf"
// Configures the print destination
iDestination(iPDF, UniqueFileName)
// Prints the RPT_Customer report
iPrintReport(RPT_Customer, "D", "D" + hMaxVal)
// Sends the file to the browser
FileDisplay(UniqueFileName, "application/pdf")
// Deletes the file
fDelete(UniqueFileName)

Printing a report with parameters based on a data file

To print a report with parameters, parameters must be passed to the report. See the Reports with parameters for more details.

To print a report with parameters based on a data file, you must:

1. Configure the report print destination:
   • In WINDEV, with iDestination (report viewer, print in an HTML file, etc.).
   • In WEBDEV, with iDestination (print in an HTML file, ...).
   • In Android and iOS, with iDestination (print in a PDF file).
   • In Windows Mobile, with iConfigure or iParameter. These functions open a dialog box allowing the user to select the default printer.
     See Print modes of a report for more details.
2. Specify the following parameters via iPrintReport:
   • the name of the report to print.
   • the parameters expected by the report (in the order specified in the report).

WINDEV example

The "RPT_Param" report corresponds to a mailshot sent to the customers. This report expects in parameter:

• the text of this mailshot entered in the "EDT_MailshotText" edit control.
• the date for sending this mailshot entered in the "EDT_SendDate" edit control.

This report is printed when "BTN_Print" is clicked on. The "RPT_param" report is based on the "Customer" data file.

In this example:

• the click code of "BTN_Print" is as follows:
  
  // Open the report viewer
  iDestination(iViewer)
  // Print the report with parameters
  iPrintReport(RPT_Param, EDT_MailshotText, EDT_SendDate)
  
• the code of the report is as follows:
  
  // Retrieve parameters passed to the report and
  // pass default parameters to test the report
  PROCEDURE RPT_Param(sText = "Default", sDate = Today())
  

Windows Mobile example

The "RPT_Param" report corresponds to an invoice. This report expects in parameter the delivery date entered in the edit control named "EDT_DelDate".

This report is printed when "BTN_Print" is clicked on. The "RPT_param" report is based on the "Customer" data file.

In this example:

• the click code of "BTN_Print" is as follows:
  
  // Select the printer
  iConfigure()
  // Print the report with parameters
  iPrintReport(RPT_Param, EDT_DelDate)
  
• the code of the report is as follows:
  
  // Retrieve parameters passed to the report and
  // pass default parameters to test the report
  PROCEDURE RPT_Param(sDate = Today())
  

Android/iOS example

The "RPT_Param" report corresponds to an invoice. This report expects in parameter the delivery date entered in the edit control named "EDT_DelDate".

This report is printed when "BTN_Print" is clicked on. The "RPT_param" report is based on the "Customer" data file.

In this example:

• the click code of "BTN_Print" is as follows:
  
  // Configures the print destination
  iDestination(iPDF)
  // Print the report with parameters
  iPrintReport(RPT_Param, EDT_DelDate)
  
• the code of the report is as follows:
  
  // Retrieve parameters passed to the report and
  // pass default parameters to test the report
  PROCEDURE RPT_Param(sDate = Today())
  

WEBDEV example The "RPT_Order" report is a report with parameters used to print the order of a customer identified by his customer number. The "RPT_Order" report is displayed in a PDF file. This PDF file is sent to the browser when "BTN_Order" is clicked on.

In this example:

• the click code of "BTN_Order" is as follows:
  
  // Generates a unique file name
  UniqueFileName is string = fWebDir() + "\" + "Invoice_" + ...
  DateSys() + TimeSys() + ".pdf"
  // Configures the print destination
  iDestination(iPDF, UniqueFileName)
  // Generates the order form
  iPrintReport(RPT_Order, CUSTOMER.CUUNIQUEKEY)
  
• the code of the report is as follows:
  
  // Retrieve parameters passed to the report and
  // pass default parameters to test the report
  PROCEDURE RPT_Order(nCustomerID = 450)
  

Printing a bounded report with parameters based on a data file

To print a bounded report with parameters based on a data file, you must:

1. Configure the report print destination:
   • In WINDEV, with iDestination (report viewer, print in an HTML file, etc.).
   • In WEBDEV, with iDestination (print in an HTML file, ...).
   • In Android and iOS, with iDestination (print in a PDF file).
   • In Windows Mobile, with iConfigure or iParameter. These functions open a dialog box allowing the user to select the default printer.
     See Print modes of a report for more details.
2. Specify the following parameters via iPrintReport:
   • the name of the report to print.
   • the value of the lower bound for the report.
   • the value of the upper bound for the report.
   • the parameters expected by the report (in the order specified in the report).

WINDEV example The "RPT_Param" report corresponds to a mailshot sent to the customers whose name starts with the letter "D" or "E".

The lower bound corresponds to: "D" and the upper bound to: "E".

This report expects in parameter:

• the text of this mailshot entered in the "EDT_MailshotText" edit control.
• the date for sending this mailshot entered in the "EDT_SendDate" edit control.

This report is printed when "BTN_Print" is clicked on. The "RPT_param" report is based on the "Customer" data file.

In this example, the click code of "BTN_Print" is as follows:

// Open report viewer
iDestination(iViewer)
// Print the report while passing bounds and parameters
iPrintReport(RPT_Param, "D", "E", EDT_MailshotText, EDT_SendDate)

Windows Mobile example

The "RPT_Param" report corresponds to an invoice sent to the customers whose name starts with the letter "D" or with the letter "E".

The lower bound corresponds to: "D" and the upper bound to: "E".

This report expects in parameter the delivery date entered in the edit control named "EDT_DelDate".

This report is printed when "BTN_Print" is clicked on. The "RPT_param" report is based on the "Customer" data file.

In this example, the click code of "BTN_Print" is as follows:

// Select the printer
iConfigure()
// Print the report with bounds and parameters
iPrintReport(RPT_Param, "D", "E", EDT_DelDate)

Android/iOS example

The "RPT_Param" report corresponds to an invoice sent to the customers whose name starts with the letter "D" or with the letter "E".

The lower bound corresponds to: "D" and the upper bound to: "E".

This report expects in parameter the delivery date entered in the edit control named "EDT_DelDate".

This report is printed when "BTN_Print" is clicked on. The "RPT_param" report is based on the "Customer" data file.

In this example, the click code of "BTN_Print" is as follows:

// Configures the print destination
iDestination(iPDF)
// Print the report with bounds and parameters
iPrintReport(RPT_Param, "D", "E", EDT_DelDate)

WEBDEV example

The "RPT_Param" report is used to print the invoices of a given customer for the month of January 2004.

The lower bound corresponds to: "01/01/2004" and the upper bound to: "31/01/2004".

This report expects the customer number in parameter. This report is displayed in a PDF file when "BTN_Print" is clicked on.

In this example, the click code of "BTN_Print" is as follows:

// Generates a unique file name
UniqueFileName is string = fWebDir() + "\" + "RPT_Param_" + ...
DateSys() + TimeSys() + ".pdf"
// Configures the print destination
iDestination(iPDF, UniqueFileName)
// Prints the report while passing bounds and parameters
iPrintReport(RPT_Param, "01012003", "31012003", CustNum)
// Sends the file to the browser
FileDisplay(UniqueFileName, "application/pdf")