sethtmlpageheader

(mPDF ≥ 2.0)

sethtmlpageheader – Set an HTML page header by a given name

Description

< sethtmlpageheader [ $name ] [ $page ] [ $value ] [ $show-this-page ] />

Sets an HTML page header that has previously been defined by name.

Parameters

$name

This parameter specifies the name of a previously defined HTML page header. If a BLANK string or null is passed, mPDF will use the value '_default' if such a page header exists.

The $name does not need to be defined if you are setting the value to '-1' or 'off'

$page

Specify whether to set the header for ODD or EVEN pages in a DOUBLE-SIDED document.

Default: 'ODD'

Note: setting this value to BLANK will not clear the header; set $value to '-1' or 'off' to cancel the header

Values (case-insensitive)

• 'O' or 'ODD' - set the header for ODD pages in a DOUBLE-SIDED document, or for both ODD and EVEN in a SINGLE-SIDED document.
• 'E' or 'EVEN' - set the header for EVEN pages
• 'ALL' - sets the header for both ODD and EVEN pages.

If the $page value is BLANK or omitted - sets the header for ODD in a DOUBLE-SIDED document, or for both ODD and EVEN in a SINGLE-SIDED document.

$value

Specify whether to start or stop showing the named header from the current position in the document.

Values (case-insensitive)

• '1' or 'ON' - start using this named header
• '-1' or 'OFF' - stop using a header

Default: BLANK is ignored, making no changes to the current state

$show-this-page

If $show-this-page is set to "1" (or any positive value) it forces the header to be written immediately to the current page. Use if the header is being set after the new page has been added.

Default: BLANK

Changelog

Examples

For examples and further information please see:

• Headers & Footers
• Headers & Footers - Method 4

See Also

• DefHTMLHeaderByName()
• <htmlpageheader>
• SetHTMLFooterByName()
• <sethtmlpagefooter>