This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

FOOTING clause

Inserts a footer on each page of displayed output.

Synopsis

FOOTING "text['code']"


Description

The FOOTING and FOOTER keywords are synonyms.

The FOOTING clause causes the specified footer to be displayed (or printed) at the bottom of each page of CMQL output, with the exception of the final page. This footer can consist of any combination of literal text and code characters. Note that footer literal text is in outer quotes and code characters are in nested quotes.

The available outer quotes are "text" or \text\. Inner (nested) quotes must be single quotes. Therefore, to display a text and a page number footer you must specify a footer such as "This is page 'P' of my report" or \This is page 'P' of my report\.

Footer Code Characters

The following footer code characters can be included in a specified footer:

 ‘B’ The BREAK-ON field value. Refer to the BREAK-ON clause for details. ‘C’ Center the footer. The default is left justified. ‘D’ Date. Inserts the current system date in DD MMM YYYY format. For example, 25 May 2010. ‘G’ Right justify the following text. The default is left justified. ‘L’ Line break inserted in the footer at this point. ‘N’ No page break prompts. Displays the header at the top of each page, displays all of the pages without waiting for user prompting for the next page. ‘P’ Page numbers incrementing from 1 with leading indent. For example, "This is page'P' of my report". ‘Q’ Treat \, ], and ^ as literals, not code characters for rest of header. ‘S’ Page numbers incrementing from 1 with no indent. For example, "This is page 'S' of my report". ‘T’ Time and date. Inserts the current system timestamp in 12–hour format: hh:mm:ss DD MMM YYYY. For example, 9:35:22am 25 May 2010. Note that the time increments for each page. ^ Page number. Same as ‘P’ \ Time and date. Inserts the current system timestamp in 12–hour format: hh:mm:ss DD MMM YYYY format. For example, "Report printed \ for your review". Same as ‘T’. ] Line break. Same as ‘L’ \“\ A literal double quote character. For example, \Report is "mostly" accurate\ \'‘\ or “’‘” A literal single quote character, specified as two single quote characters. For example, "Don''t review"

You can specify more than one letter code within nested quotes. For example, "Report printed 'CTLC' For your review" displays a two-line footer with both lines centered, and the with first line containing the current system timestamp.

For further details on using footer codes, refer to the MVBasic FOOTING command, which uses the same codes.