Struct HeaderFooter 

pub struct HeaderFooter {
    pub blocks: Vec<Block>,
}

The content of a header or footer: a sequence of block-level content (paragraphs and tables) — the same content model WordprocessingML gives the document body (CT_HdrFtr reuses EG_BlockLevelElts, the exact group w:body uses), just without a w:body wrapper or section properties of its own.

Fields

blocks: Vec<Block>

The blocks that make up this header/footer’s content, in order.

Implementations

impl HeaderFooter

pub fn new() -> HeaderFooter

Creates an empty header/footer.

Examples found in repository

examples/docx_page_layout.rs (line 27)

fn main() -> office_toolkit::Result<()> {
    let path = output_path("docx_page_layout.docx");

    let page_setup = PageSetup::new()
        .with_size_twips(16_838, 11_906) // A4 landscape, in twentieths of a point
        .with_orientation(Orientation::Landscape)
        .with_margins_twips(1_440, 1_440, 1_800, 1_800) // top, bottom, left, right
        .with_header_footer_margins_twips(720, 720)
        .with_gutter_twips(0)
        .with_columns(2);

    let default_header =
        HeaderFooter::new().with_paragraph(Paragraph::with_text("Default header — every page"));
    let default_footer =
        HeaderFooter::new().with_paragraph(Paragraph::with_text("Default footer — every page"));
    let first_header = HeaderFooter::new()
        .with_paragraph(Paragraph::with_text("First-page header — cover page only"));
    let even_header = HeaderFooter::new().with_paragraph(Paragraph::with_text("Even-page header"));

    let document = Document::new()
        .with_page_setup(page_setup)
        .with_header(default_header)
        .with_footer(default_footer)
        .with_header_first(first_header)
        .with_header_even(even_header)
        .with_paragraph(heading("Page setup: A4 landscape, custom margins, two columns", false))
        .with_paragraph(Paragraph::with_text(
            "This document is landscape A4, with wider left/right margins than top/bottom, and its body text \
             flows in two columns. Look at the page in Word's Layout view to see the effect.",
        ))
        .with_paragraph(heading("Headers and footers", true))
        .with_paragraph(Paragraph::with_text(
            "Page 1 (this page) uses the first-page header, since \"different first page\" headers are set. \
             Every other page uses the default header shown above, and every page uses the default footer.",
        ))
        .with_paragraph(heading("A third page, to see the default header again", true))
        .with_paragraph(Paragraph::with_text(
            "If Word is configured to show even/odd pages differently, this page alternates between the \
             default and even-page header depending on whether it lands on an even or odd page number.",
        ));

    document.save_to_file(&path)?;
    println!("Wrote {}", path.display());
    Ok(())
}

pub fn with_paragraph(self, paragraph: Paragraph) -> HeaderFooter

Appends a paragraph block and returns it for chaining.

Examples found in repository

examples/docx_page_layout.rs (line 27)

fn main() -> office_toolkit::Result<()> {
    let path = output_path("docx_page_layout.docx");

    let page_setup = PageSetup::new()
        .with_size_twips(16_838, 11_906) // A4 landscape, in twentieths of a point
        .with_orientation(Orientation::Landscape)
        .with_margins_twips(1_440, 1_440, 1_800, 1_800) // top, bottom, left, right
        .with_header_footer_margins_twips(720, 720)
        .with_gutter_twips(0)
        .with_columns(2);

    let default_header =
        HeaderFooter::new().with_paragraph(Paragraph::with_text("Default header — every page"));
    let default_footer =
        HeaderFooter::new().with_paragraph(Paragraph::with_text("Default footer — every page"));
    let first_header = HeaderFooter::new()
        .with_paragraph(Paragraph::with_text("First-page header — cover page only"));
    let even_header = HeaderFooter::new().with_paragraph(Paragraph::with_text("Even-page header"));

    let document = Document::new()
        .with_page_setup(page_setup)
        .with_header(default_header)
        .with_footer(default_footer)
        .with_header_first(first_header)
        .with_header_even(even_header)
        .with_paragraph(heading("Page setup: A4 landscape, custom margins, two columns", false))
        .with_paragraph(Paragraph::with_text(
            "This document is landscape A4, with wider left/right margins than top/bottom, and its body text \
             flows in two columns. Look at the page in Word's Layout view to see the effect.",
        ))
        .with_paragraph(heading("Headers and footers", true))
        .with_paragraph(Paragraph::with_text(
            "Page 1 (this page) uses the first-page header, since \"different first page\" headers are set. \
             Every other page uses the default header shown above, and every page uses the default footer.",
        ))
        .with_paragraph(heading("A third page, to see the default header again", true))
        .with_paragraph(Paragraph::with_text(
            "If Word is configured to show even/odd pages differently, this page alternates between the \
             default and even-page header depending on whether it lands on an even or odd page number.",
        ));

    document.save_to_file(&path)?;
    println!("Wrote {}", path.display());
    Ok(())
}

pub fn with_table(self, table: Table) -> HeaderFooter

Appends a table block and returns it for chaining.

pub fn with_structured_document_tag( self, sdt: StructuredDocumentTag, ) -> HeaderFooter

Appends a structured document tag block and returns it for chaining.

pub fn paragraphs(&self) -> impl Iterator<Item = &Paragraph>

Iterates over this header/footer’s paragraphs only, skipping tables.

pub fn tables(&self) -> impl Iterator<Item = &Table>

Iterates over this header/footer’s tables only, skipping paragraphs.

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<(), Error>

Formats the value using the given formatter.

impl Default for HeaderFooter

fn default() -> HeaderFooter

Returns the “default value” for a type.

impl PartialEq for HeaderFooter

fn eq(&self, other: &HeaderFooter) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for HeaderFooter