TOP-OF-PAGE
Basic form
TOP-OF-PAGE.
Addition:
... DURING LINE-SELECTION
Effect
TOP-OF-PAGE is a list processing event which is executed before the first data is output on a new page.
Notes
-
Without the addition
... DURING LINE-SELECTION, TOP-OF-PAGE is processed only when generating basic lists, not when creating secondary lists.
-
TOP-OF-PAGE allows you to define output which supplements
the standard page header at the beginning of the page. Alternatively, if the standard page header is
suppressed (with (REPORT ... NO STANDARD PAGE HEADING.), it allows you to design your own page header.
-
TOP-OF-PAGE is only executed before outputting the first
line on a new page. It is not triggered by a NEW-PAGE statement
-
List lines that are output in TOP-OF-PAGE remain as a
fixed header for the current page, that is, they do not scroll when you scroll vertically. The
TOP-OF-PAGE area of a list page should therefore not be so
long that it occupies the entire page (under standard settings), since the user will then not be able to scroll at all.
-
NEW-PAGE statements in the TOP-OF-PAGE coding are ignored.
Example
PROGRAM DOCUEXAM NO STANDARD PAGE HEADING.
START-OF-SELECTION.
WRITE: / 'line
1'.
WRITE: / 'line 2'.
WRITE: / 'line 3'.
TOP-OF-PAGE.
WRITE: / 'Heading'.
ULINE.
This program produces the following output:
Heading
-------------------------------
line 1
line 2
line 3
Addition
... DURING LINE-SELECTION
Effect
Ensures that TOP-OF-PAGE is executed when generating secondary
lists. (AT LINE-SELECTION, AT USER-COMMAND).
Note
The event TOP-OF-PAGE DURING LINE-SELECTION. is executed
when generating each secondary list. If you want to generate different page headers for different secondary lists, you must specify this in the program (e.g. by using status variables).
Related
END-OF-PAGE
Additional help
Lists with Multiple Pages