JadeReport Class

The JadeReport class holds the description of the report output data and enables you to access an entire printed report. This print data can be stored or sent directly to a printer or display device.

Each page of print output is contained in a Windows metafile by default, which contains details of all Application Programming Interfaces (APIs) calls necessary to reproduce print output in a form independent of the printer device, to enable you to preview printed output.

JADE print data can be one of the following formats.

The choice of meta file format (EMF or SVG) and print data type (GDI or PS) are controlled by the PrintFileFormat and PrintDataType parameters, respectively, in the [JadePrinting] section of the JADE initialization file. Although output to a printer can be done using GDI or PS commands, the format of the meta file (that is, EMF or SVG) determines whether you can use the Postscript data type for print output. For more details, see "Portable Printing" under "Printer Class".

The following is an example of the code required to capture the report output data and then store it persistently.

vars
    report : JadeReport;
begin
    create report transient;
    app.printer.setReport(report);
    ...                  // Do some processing here
    // create print output
    ...                  // Do some processing here
epilog
    app.printer.close;
    // Clone the report output in the report variable to a persistent
    // version of the JadeReport, JadePrintPage, and JadePrintDirect
    // subclasses
    delete report;
end;

By default, when a print preview is requested, a JadeReport object is created that contains the list of JadePrintDirect and JadePrintPage entries. This JadeReport object is invisible and transparent to you.

Use the Printer class setReport method to capture this output for storage, manipulation, and printing to meet your requirements. Alternatively, use the Printer class printReport method to print the specified report on the current printer if the printPreview property is set to false or print the report in preview mode if the printPreview property is set to true.

Client-side facilities only are available. Print facilities cannot be invoked from a server method.

If you are running JADE in thin client mode, the printing is performed on the presentation client using a printer attached to the presentation client workstation. When the presentation client requests a print preview, the pages of the printed report do not have to be transferred to and from the application server. (This optimizes the performance of the print preview process when running JADE thin client mode over a slow network.) However, if your application calls Printer class setReport to indicate that user logic subsequently stores or manipulates the report output, each page of output is transferred to the application server.

For details about the properties and method defined in the JadeReport class, see "JadeReport Properties" and "JadeReport Method", in the following subsections.

Object

(None)