PdfHeaderFooter class

A repeating header or footer: up to three text slots (left, centre, right) drawn in Helvetica. Each slot is a template that may contain the dynamic tokens {page} (1-based page number), {pages} (page count), {label} (the logical page label when the document carries /PageLabels, else the page number), and {date} (the stamp date as YYYY-MM-DD).

Constructors

PdfHeaderFooter({String? left, String? center, String? right, double size = 9, int color = 0x000000, bool bold = false, double margin = 36})
const

Properties

bold → bool
Whether to use Helvetica-Bold.
final
center → String?
Centred slot template.
final
color → int
Text colour, 0xRRGGBB.
final
hashCode → int
The hash code for this object.
no setterinherited
left → String?
Left-aligned slot template, or null to leave it empty.
final
margin → double
Distance in points from the page edge: the left/right slots sit this far in from the crop-box sides, and the baseline this far from the top (header) or bottom (footer) edge.
final
Right-aligned slot template.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
size → double
Font size in points.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited