Report function library

Use the functions in this library to create Quick Reports for your application. Quick Reports are generated completely from sanScript, making them flexible and fast. They are typically used for reports that must be produced quickly and won’t require user modifications.

Quick Report concepts

A Quick Report is generated one page at a time. Each page is composed of bands, which specify areas of the report in which you insert text. A Quick Report must have at least one band, and typically has one band for each line of text in the report. Bands are shown in the following illustration.

The first band of the report always starts in the upper left corner and extends the width of the page. You specify the band’s height. Once a band is created, you add text items to it. Typically, you will add only one text item to the band, but you can add several items if necessary. When you have finished adding text to the current band, you create a new one. The new band starts immediately below the previous band, extends the width of the page, and has the height you specify.

When you have added enough bands to fill the page, you must start a new page and continue the process until the report is complete.

Creating a Quick Report

This library contains the following functions:

• Report_Begin()
• Report_DoubleLine()
• Report_End()
• Report_GetPageRemaining()
• Report_GetPageSize()
• Report_GetStringWidth()
• Report_NewBand()
• Report_NewPage()
• Report_ReadyToRun()
• Report_SetFont()
• Report_SingleLine()
• Report_WriteText()

When you create a Quick Report, you will typically use these functions in the following manner:

• The Report_Begin() function starts the Quick Report.
• The Report_GetPageSize() function returns the dimension of the page. The values are returned are in points. There are 72 points per inch. You will use the page dimensions to calculate how many lines will fit on a page.
• The Report_NewBand() function creates a new band on the report.
• The Report_SetFont() function specifies characteristics of the text that will be written to the report.
• The Report_WriteText() function writes a text item to the current band.
• When the current page is complete, the Report_NewPage() function adds a new page to the report.
• The Report_End() function completes the Quick Report.

Documentation Feedback

---