Struct NumberingDefinition 

pub struct NumberingDefinition {
    pub id: u32,
    pub levels: Vec<ListLevel>,
}

A numbering (list) definition declared in word/numbering.xml, referenced from paragraphs (Paragraph.numbering_id) by id.

WordprocessingML actually splits a list definition into two linked elements: w:abstractNum (the real level formatting, CT_AbstractNum) and w:num (CT_Num, a thin indirection paragraphs reference by numId, pointing at an abstractNumId) — this indirection exists so several w:num entries can share one w:abstractNum, which real Word documents do use, but which this crate doesn’t need for the common case of one standalone list. So this type collapses both into one value: id corresponds to w:num’s numId (what a paragraph actually references), and a dedicated w:abstractNum is always written alongside it internally — see writer.rs. Reading back a real, externally-authored document that DOES share one w:abstractNum across several w:num entries still works (each w:num becomes its own NumberingDefinition, with its levels resolved through whichever w:abstractNum it points to), just without preserving that sharing structure on a round trip.

Fields

id: u32

This definition’s id (w:num’s w:numId), referenced by Paragraph.numbering_id.

levels: Vec<ListLevel>

The formatting for each indent level this list defines, in order (index 0 is the outermost level, w:lvl’s ilvl="0"). WordprocessingML allows up to 9 (ilvl 0-8); most real lists only need 1-3.

Implementations

impl NumberingDefinition

pub fn new(id: u32, levels: Vec<ListLevel>) -> NumberingDefinition

Creates a numbering definition with the given id and levels (fully custom — see NumberingDefinition::bullet/ NumberingDefinition::decimal for ready-made common cases).

Examples found in repository

examples/docx_styles_and_lists.rs (lines 25-31)

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

    let heading_style = Style::new("Heading1", "Heading 1", StyleKind::Paragraph)
        .with_bold(true)
        .with_font_size(32);
    let emphasis_style = Style::new("StrongEmphasis", "Strong Emphasis", StyleKind::Character)
        .with_bold(true)
        .with_color("C00000");

    let bulleted = NumberingDefinition::bullet(1);
    let numbered = NumberingDefinition::decimal(2);
    let custom = NumberingDefinition::new(
        3,
        vec![
            ListLevel::new(NumberFormat::UpperRoman, "%1.", 720, 360),
            ListLevel::new(NumberFormat::LowerLetter, "%2)", 1440, 360),
        ],
    );

    let document = Document::new()
        .with_style(heading_style)
        .with_style(emphasis_style)
        .with_numbering_definition(bulleted)
        .with_numbering_definition(numbered)
        .with_numbering_definition(custom)
        .with_paragraph(heading("Named paragraph and character styles", false))
        .with_paragraph(
            Paragraph::with_text("This paragraph uses the Heading 1 style.")
                .with_style_id("Heading1"),
        )
        .with_paragraph(
            Paragraph::new()
                .with_run(Run::new("Plain text, then "))
                .with_run(Run::new("some strongly emphasized text").with_style_id("StrongEmphasis"))
                .with_run(Run::new(", then plain text again.")),
        )
        .with_paragraph(heading("Bulleted list", true))
        .with_paragraph(Paragraph::with_text("First item").with_numbering(1, 0))
        .with_paragraph(Paragraph::with_text("Second item").with_numbering(1, 0))
        .with_paragraph(Paragraph::with_text("A sub-item, one level deeper").with_numbering(1, 1))
        .with_paragraph(heading("Numbered list", true))
        .with_paragraph(Paragraph::with_text("First step").with_numbering(2, 0))
        .with_paragraph(Paragraph::with_text("Second step").with_numbering(2, 0))
        .with_paragraph(
            Paragraph::with_text("A sub-step, cumulatively numbered").with_numbering(2, 1),
        )
        .with_paragraph(heading(
            "Custom multi-level list (roman numerals, then letters)",
            true,
        ))
        .with_paragraph(Paragraph::with_text("First top-level item").with_numbering(3, 0))
        .with_paragraph(Paragraph::with_text("A lettered sub-item").with_numbering(3, 1))
        .with_paragraph(Paragraph::with_text("Second top-level item").with_numbering(3, 0));

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

pub fn bullet(id: u32) -> NumberingDefinition

A ready-made 3-level bulleted (unordered) list, using the same bullet characters, format and indentation Word’s own default “Bullets” gallery entry uses when it doesn’t need to fall back to a Wingdings/Symbol-font glyph — this crate doesn’t model fonts, so plain Unicode bullet characters are used instead of Word’s own Wingdings/Symbol ones (which would render as the wrong glyph without the matching font declared on the run).

Examples found in repository

examples/docx_styles_and_lists.rs (line 23)

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

    let heading_style = Style::new("Heading1", "Heading 1", StyleKind::Paragraph)
        .with_bold(true)
        .with_font_size(32);
    let emphasis_style = Style::new("StrongEmphasis", "Strong Emphasis", StyleKind::Character)
        .with_bold(true)
        .with_color("C00000");

    let bulleted = NumberingDefinition::bullet(1);
    let numbered = NumberingDefinition::decimal(2);
    let custom = NumberingDefinition::new(
        3,
        vec![
            ListLevel::new(NumberFormat::UpperRoman, "%1.", 720, 360),
            ListLevel::new(NumberFormat::LowerLetter, "%2)", 1440, 360),
        ],
    );

    let document = Document::new()
        .with_style(heading_style)
        .with_style(emphasis_style)
        .with_numbering_definition(bulleted)
        .with_numbering_definition(numbered)
        .with_numbering_definition(custom)
        .with_paragraph(heading("Named paragraph and character styles", false))
        .with_paragraph(
            Paragraph::with_text("This paragraph uses the Heading 1 style.")
                .with_style_id("Heading1"),
        )
        .with_paragraph(
            Paragraph::new()
                .with_run(Run::new("Plain text, then "))
                .with_run(Run::new("some strongly emphasized text").with_style_id("StrongEmphasis"))
                .with_run(Run::new(", then plain text again.")),
        )
        .with_paragraph(heading("Bulleted list", true))
        .with_paragraph(Paragraph::with_text("First item").with_numbering(1, 0))
        .with_paragraph(Paragraph::with_text("Second item").with_numbering(1, 0))
        .with_paragraph(Paragraph::with_text("A sub-item, one level deeper").with_numbering(1, 1))
        .with_paragraph(heading("Numbered list", true))
        .with_paragraph(Paragraph::with_text("First step").with_numbering(2, 0))
        .with_paragraph(Paragraph::with_text("Second step").with_numbering(2, 0))
        .with_paragraph(
            Paragraph::with_text("A sub-step, cumulatively numbered").with_numbering(2, 1),
        )
        .with_paragraph(heading(
            "Custom multi-level list (roman numerals, then letters)",
            true,
        ))
        .with_paragraph(Paragraph::with_text("First top-level item").with_numbering(3, 0))
        .with_paragraph(Paragraph::with_text("A lettered sub-item").with_numbering(3, 1))
        .with_paragraph(Paragraph::with_text("Second top-level item").with_numbering(3, 0));

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

pub fn decimal(id: u32) -> NumberingDefinition

A ready-made 3-level numbered (ordered) list, using the same cumulative numbering (each level repeats its ancestors’ counters, e.g. “1.1.1.”) and indentation Word’s own default “Numbering” gallery entry uses.

Examples found in repository

examples/docx_styles_and_lists.rs (line 24)

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

    let heading_style = Style::new("Heading1", "Heading 1", StyleKind::Paragraph)
        .with_bold(true)
        .with_font_size(32);
    let emphasis_style = Style::new("StrongEmphasis", "Strong Emphasis", StyleKind::Character)
        .with_bold(true)
        .with_color("C00000");

    let bulleted = NumberingDefinition::bullet(1);
    let numbered = NumberingDefinition::decimal(2);
    let custom = NumberingDefinition::new(
        3,
        vec![
            ListLevel::new(NumberFormat::UpperRoman, "%1.", 720, 360),
            ListLevel::new(NumberFormat::LowerLetter, "%2)", 1440, 360),
        ],
    );

    let document = Document::new()
        .with_style(heading_style)
        .with_style(emphasis_style)
        .with_numbering_definition(bulleted)
        .with_numbering_definition(numbered)
        .with_numbering_definition(custom)
        .with_paragraph(heading("Named paragraph and character styles", false))
        .with_paragraph(
            Paragraph::with_text("This paragraph uses the Heading 1 style.")
                .with_style_id("Heading1"),
        )
        .with_paragraph(
            Paragraph::new()
                .with_run(Run::new("Plain text, then "))
                .with_run(Run::new("some strongly emphasized text").with_style_id("StrongEmphasis"))
                .with_run(Run::new(", then plain text again.")),
        )
        .with_paragraph(heading("Bulleted list", true))
        .with_paragraph(Paragraph::with_text("First item").with_numbering(1, 0))
        .with_paragraph(Paragraph::with_text("Second item").with_numbering(1, 0))
        .with_paragraph(Paragraph::with_text("A sub-item, one level deeper").with_numbering(1, 1))
        .with_paragraph(heading("Numbered list", true))
        .with_paragraph(Paragraph::with_text("First step").with_numbering(2, 0))
        .with_paragraph(Paragraph::with_text("Second step").with_numbering(2, 0))
        .with_paragraph(
            Paragraph::with_text("A sub-step, cumulatively numbered").with_numbering(2, 1),
        )
        .with_paragraph(heading(
            "Custom multi-level list (roman numerals, then letters)",
            true,
        ))
        .with_paragraph(Paragraph::with_text("First top-level item").with_numbering(3, 0))
        .with_paragraph(Paragraph::with_text("A lettered sub-item").with_numbering(3, 1))
        .with_paragraph(Paragraph::with_text("Second top-level item").with_numbering(3, 0));

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

Trait Implementations

impl Clone for NumberingDefinition

fn clone(&self) -> NumberingDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NumberingDefinition

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

Formats the value using the given formatter.

impl Eq for NumberingDefinition

impl PartialEq for NumberingDefinition

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for NumberingDefinition