Navigation: Language Reference > 7 - Reports > Report Structures >====== HEADER (page or group header structure) ====== | |
HEADER ,AT( ) | [,FONT( )] [,ABSOLUTE] [,PAGEBEFORE( )] [,PAGEAFTER( )] | |
[,WITHPRIOR( )] [,WITHNEXT( )] [,ALONE] [,USE( )] [,COLOR( )] [,TOGETHER] | ||
controls | ||
END |
HEADER | Declares a page or group header structure. |
AT | Specifies the size and location of the HEADER (PROP:AT). |
FONT | Specifies the default font for all controls in this structure (PROP:FONT). If omitted, the REPORT's FONT attribute (if present) is used, or else the printer's default font is used. |
ABSOLUTE | Declares the HEADER prints at a fixed position relative to the page (PROP:ABSOLUTE). Valid only on a HEADER within a BREAK structure. |
PAGEBEFORE | Declares the HEADER prints at the start of a new page after activating normal page overflow actions (PROP:PAGEBEFORE). Valid only on a HEADER within a BREAK structure. |
PAGEAFTER | Declares the HEADER prints, and then starts a new page by activating normal page overflow actions (PROP:PAGEAFTER). Valid only on a HEADER within a BREAK structure. |
WITHPRIOR | Declares the HEADER prints on the same page as the DETAIL, group HEADER, or FOOTER that immediately precedes it during printing (PROP:WITHPRIOR). Valid only on a HEADER within a BREAK structure. |
WITHNEXT | Declares the HEADER prints on the same page as the DETAIL, group HEADER, or FOOTER that immediately follows it during printing (PROP:WITHNEXT). Valid only on a HEADER within a BREAK structure. |
ALONE | Declares the (group) HEADER structure must be printed on a page without FORM, (page) HEADER, or (page) FOOTER structures (PROP:ALONE). |
USE | A field equate label to reference the HEADER structure in executable code (PROP:USE). |
COLOR | Specifies a background color for the HEADER and the default background color for the controls in the HEADER (PROP:COLOR). |
TOGETHER | Specifies that the DETAIL, or group HEADER or FOOTER structure (contained within a BREAK structure), is to only print on a single page, rather than being automatically split if there is not sufficient room for it (PROP:Together). |
controls | Report output control fields. |
The HEADER structure declares the output which prints at the beginning of each page or group. A HEADER structure must be terminated with a period or END statement.
A HEADER structure that is not within a BREAK structure is a page header. Only one page HEADER is allowed in a REPORT. The page HEADER is automatically printed whenever a page break occurs, at the page-relative position specified by its AT attribute.
The BREAK structure defines a group break. It may contain its own HEADER, FOOTER, and DETAIL structures, and/or other nested BREAK structures. It may also contain multiple DETAIL structures. The HEADER and FOOTER structures that are within a BREAK structure are the group header and footer. They are automatically printed when the value in a specified group break variable changes, at the next position available in the detail print area (specified by the REPORT's AT attribute). Only one HEADER is allowed in a BREAK structure.
Example:
CustRpt REPORT !Declare customer report
HEADER ! begin page header declaration
!report controls
END ! end header declaration
Break1 BREAK(SomeVariable)
HEADER ! begin group header declaration
!report controls
END ! end header declaration
GroupDet DETAIL
!report controls
END ! end detail declaration
END ! end group break declaration
END !End report declaration