BEGIN-HEADING

Function

Begins a HEADING section.

Syntax

BEGIN-HEADING heading_lines_int_lit
[FOR-REPORTS=(report_name1[, report_namei]...)]
[FOR-TOCS=(toc_name1[, toc_namei]...)]
[NAME={heading_name}]
END-HEADING

Arguments

heading_lines_int_lit

Number of lines to reserve at the top of each page.

FOR-REPORTS

Reports to which this heading applies. Only required for programs with multiple reports.

FOR-TOCS

Table of Contents to which this heading applies.

NAME

Name associated with this heading section. Cannot use if FOR‑REPORTS or FOR-TOCS is also defined. Used in conjunction with ALTER-REPORT. Cannot be NONE or DEFAULT.

Description

The HEADING section defines and controls information printed at the top of each page.

Define report_name in DECLARE-REPORT. If you do not use DECLARE-REPORT, the heading is applied to all reports. You can also define FOR‑REPORTS=(ALL). (The parentheses are required.)

There can only be one BEGIN-HEADING section for each report. A BEGIN-HEADING section with FOR‑REPORTS=(ALL) can be specified followed by other BEGIN-HEADING sections for specific reports, which override ALL.

Define toc_name in DECLARE-TOC. You can also specify FOR‑TOCS=(ALL). (The parentheses are required.)

There can only be one Table of Contents for each BEGIN-HEADING section. A BEGIN-HEADING section with FOR‑TOCS=(ALL) can be specified followed by other BEGIN-HEADING sections for specific Table of Contents, which override ALL.

BEGIN-HEADING sections can be shared between reports and Table of Contents.

You can print outside the heading area of the report from the heading, but you cannot print into the heading area from the body.

Examples

begin-heading 2                           ! Use 2 lines for heading,
print $current-date (1,1) edit MM/DD/YY   ! 2nd is blank.
  print 'Sales for the Month of ' (1,30)
  print $month ()
end-heading

begin-heading 2 for-tocs=(all) 
  print 'Table of Contents' (1,1) bold center 
end-heading