Advanced Reporting

Purpose:

Print an advanced report created with the Report Designer utility. Tables used by the report should be opened, sorted and queried if needed prior to printing. To view a report prior to printing, see dbpPreviewReport.

Category:

Advanced Reporting

Syntax:

dbpPrintReport "database id" "report file" "options"

database id

The name assigned to the database. This parameter may be left blank when printing reports that do not contain any database elements.

report file

The name of the file containing the report to be printed. Report files can be created and edited using the Report Designer utility.

options

This is a compound parameter and can contain any combination of the following items:

PrintDialog=Yes/No	Yes = display the standard Windows print dialog prior to printing. No = do not display the print dialog - report will be printed immediately.
StartPage=value	The number of the first page in the report to be printed. Leave this and EndPage blank to print the entire report.
EndPage=value	The number of the last page in the report to be printed. Leave this and FirstPage blank to print the entire report.
Copies=value	The number of copies of the report to print.

Separate multiple items in a compound variable with semicolons (;). Unneeded items can be omitted.

Example:

dbpPrintReport "AddrBook" "SampleReport.dbr" "PrintDialog=Yes"

SQL Equivalent:

N/A

Purpose:

Preview an optionally print an advanced report created with the Report Designer utility. Tables used by the report should be opened, sorted and queried if needed prior to previewing. The preview screen's interface can be customized using the dbpTranslatePreviewHints action. To print a report without previewing, see dbpPrintReport.

Category:

Advanced Reporting

Syntax:

dbpPreviewReport "database id" "report file" "options"

database id

The name assigned to the database. This parameter may be left blank when printing reports that do not contain any database elements.

report file

The name of the file containing the report to be printed. Report files can be created and edited using the Report Designer utility.

options

This is a compound parameter and can contain any combination of the following items:

DisplayMode=value

The default preview display mode. Value may be one of the following:

200%

150%

100%

75%

50%

25%

10%

FitPage

FitWidth

FacingPages

Except for the last three options, the report viewer will display as many pages as will fit on-screen. The number of pages displayed will vary depending on the dimensions of the preview window.

InitialPage=value

The initial page to display when the preview first appears. The first page (1) is the default.

Example:

dbpPreviewReport "AddrBook" "SampleReport.dbr" "DisplayMode=FacingPages"

SQL Equivalent:

N/A

Purpose:

Customize or translate the hints and text used by dbpPreviewReport's preview screen.

Category:

Advanced Reporting

Syntax:

dbpSetPreviewHints "hints"

hints

This is a compound parameter and can contain any combination of the following items:

Title=value	Title that appears at the top of the preview window.
Print=value	Print button hint.
Zoom=value	Zoom button hint.
First=value	First page button hint.
Previous=value	Previous page button hint.
Next=value	Next page button hint.
Last=value	Last page button hint.
Close=value	Close button hint.
FitPage=value	Zoom menu's "Fit Page" item.
FitWidth=value	Zoom menu's "Fit Width" item.
FacingPages=value	Zoom menu's "Facing Pages" item.
Page=value	Page number indicator in upper right corner on preview window.
PreparingReport=value	Title that appears at the top of the progress dialog when generating report preview.
Cancel=value	Progress dialog's cancel button.
PerformingFirstPass=value	Progress dialog's first prompt.
PerformimgFinalPass=value	Progress dialog's final prompt.
PageXOfY=value	Progress dialog's page number indicator. Within this hint you must include two special codes to indicate where you want the page numbers to appear. Use the code %p to represent the current page number and %t to represent the total number of pages. For example: Página %p de %t
PrintingReport=value	Title that appears at the top of the progress dialog when printing a report.

Separate multiple items in a compound variable with semicolons (;). Unneeded items can be omitted.

Example:

The following will translate the preview screen's title and page number indicator into Spanish:

dbpSetPreviewHints "Title=Divulgue La Inspección previo;Page=Página"

SQL Equivalent:

N/A