pagefooter

(mPDF ≥ 2.0)

pagefooter – Define a page footer with a given name

Description

<pagefooter [ $name ] [ $content-left ] [ $content-center ] [ $content-right ] [ $footer-style ] [ $footer-style-left ] [ $footer-style-center ] [ $footer-style-right ] [ $line ] />

Define a page footer with a given name. Named footers can be referenced and set later in the document e.g. <setpagefooter>

Attributes

$name

This attribute is a text string to use as the name for this footer.

If name is BLANK or omitted, it is set as _default.

$content-left

$content-center

$content_right

Defines the text to appear in the page footer.

At least one content- must be defined.

Values

• $content-left: Text to appear at left margin
• $content-center: Text to appear in centre of page
• $content-right: Text to appear at right margin

$footer-style

$footer-style-left

$footer-style-center

$footer-style-right

This attribute can optionally set CSS style properties for the page footer.

$footer-style will set the same style for left, right and center content, whereas $footer-style-left, $footer-style-center and  $footer-style-right set the style for one part of the content only.

Values

Valid CSS inline style declaration but only 5 properties can be set:

• font-family
• font-size
• font-weight
• font-style
• color

If style is not set, the default values for the document are used.

$line

If set to "1" or any positive value, a line will be drawn above the footer.

Changelog

Examples

For examples and further information please see:

• Headers & Footers
• Headers & Footers - Method 3

See Also

• DefFooterByName()
• <pageheader>
• SetFooterByName()
• <setpagefooter>