Struct HeaderFooter 

pub struct HeaderFooter {
    pub left: Option<String>,
    pub center: Option<String>,
    pub right: Option<String>,
    pub font_size: f32,
    pub color: Color,
}

Header or footer text rendered on every page of a FlowDocument.

Set via FlowOptions::header and FlowOptions::footer. The placeholder strings {{page}} and {{total}} are substituted with the current page number and total page count at render time.

Example

use harumi::{FlowDocument, FlowOptions, HeaderFooter};

let font = include_bytes!("../../tests/fixtures/NotoSansJP-Regular.ttf");
let mut doc = FlowDocument::new(font.as_ref(), FlowOptions {
    footer: Some(HeaderFooter {
        center: Some("{{page}} / {{total}}".into()),
        ..Default::default()
    }),
    ..Default::default()
})?;
doc.push_paragraph("Hello!")?;
let pdf = doc.render()?;

Fields

left: Option<String>

Text aligned to the left of the area. None = no left text.

center: Option<String>

Text centered horizontally. None = no center text.

right: Option<String>

Text aligned to the right. None = no right text.

font_size: f32

Font size in PDF points. Default: 9.0.

color: Color

Color (RGB or CMYK) in 0.0..=1.0. Default: dark gray.

Implementations

impl HeaderFooter

pub fn page_number() -> Self

A centered footer showing "page / total" in dark gray at 9 pt.

Trait Implementations

impl Clone for HeaderFooter

fn clone(&self) -> HeaderFooter

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HeaderFooter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for HeaderFooter

fn default() -> Self

Returns the “default value” for a type.