Struct TabStop 

pub struct TabStop {
    pub position_twips: i32,
    pub alignment: TabStopAlignment,
    pub leader: Option<TabLeader>,
}

A single custom tab stop (w:tab, CT_TabStop), one entry of Paragraph.tabs.

Fields

position_twips: i32

The tab stop’s position, in twips, measured from the paragraph’s left margin (w:tab/@pos, ST_SignedTwipsMeasure — signed, since a tab stop can be positioned left of the margin under a negative indent).

alignment: TabStopAlignment

How text is aligned relative to this tab stop (w:tab/@val).

leader: Option<TabLeader>

The leader character repeated between the preceding text and this tab stop (w:tab/@leader), or None for a blank leader (Word’s default when the attribute is omitted).

Implementations

impl TabStop

pub fn new(position_twips: i32) -> TabStop

Creates a left-aligned tab stop at the given position, with no leader — the most common case.

Examples found in repository

examples/docx_text_formatting.rs (line 63)

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

    let document = Document::new()
        .with_paragraph(heading("Docx text formatting — bold, italic, underline, strike", false))
        .with_paragraph(Paragraph::new().with_run(Run::new("Bold text.").with_bold(true)))
        .with_paragraph(Paragraph::new().with_run(Run::new("Italic text.").with_italic(true)))
        .with_paragraph(Paragraph::new().with_run(Run::new("Single underline.").with_underline(UnderlineStyle::Single)))
        .with_paragraph(Paragraph::new().with_run(Run::new("Wavy underline.").with_underline(UnderlineStyle::Wave)))
        .with_paragraph(Paragraph::new().with_run(Run::new("Strikethrough text.").with_strike(true)))
        .with_paragraph(heading("Colors and highlight", true))
        .with_paragraph(Paragraph::new().with_run(Run::new("Red text on the default background.").with_color("FF0000")))
        .with_paragraph(Paragraph::new().with_run(Run::new("Text highlighted in yellow.").with_highlight(Highlight::Yellow)))
        .with_paragraph(
            Paragraph::new()
                .with_run(Run::new("Larger, custom font.").with_font_size(32).with_font_family("Georgia")),
        )
        .with_paragraph(heading("Superscript and subscript", true))
        .with_paragraph(
            Paragraph::new()
                .with_run(Run::new("Water is H"))
                .with_run(Run::new("2").with_vertical_align(VerticalAlign::Subscript))
                .with_run(Run::new("O.")),
        )
        .with_paragraph(
            Paragraph::new()
                .with_run(Run::new("Squared: x"))
                .with_run(Run::new("2").with_vertical_align(VerticalAlign::Superscript))
                .with_run(Run::new(".")),
        )
        .with_paragraph(heading("Small caps, all caps, character spacing", true))
        .with_paragraph(Paragraph::new().with_run(Run::new("rendered in small caps").with_small_caps(true)))
        .with_paragraph(Paragraph::new().with_run(Run::new("rendered in all caps").with_all_caps(true)))
        .with_paragraph(Paragraph::new().with_run(Run::new("Widely spaced letters.").with_character_spacing(120)))
        .with_paragraph(heading("Paragraph alignment", true))
        .with_paragraph(Paragraph::with_text("Left-aligned (the default).").with_alignment(Alignment::Left))
        .with_paragraph(Paragraph::with_text("Centered.").with_alignment(Alignment::Center))
        .with_paragraph(Paragraph::with_text("Right-aligned.").with_alignment(Alignment::Right))
        .with_paragraph(
            Paragraph::with_text(
                "Justified: this line is long enough for Word to stretch the spacing between words so both edges line up.",
            )
            .with_alignment(Alignment::Justify),
        )
        .with_paragraph(heading("Tab stops", true))
        .with_paragraph(
            Paragraph::new()
                .with_tab(TabStop::new(1_440).with_alignment(TabStopAlignment::Center))
                .with_tab(TabStop::new(2_880).with_alignment(TabStopAlignment::Right).with_leader(TabLeader::Dot))
                .with_run(Run::new("Left\tCentered\tRight, dot leader")),
        );

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

pub fn with_alignment(self, alignment: TabStopAlignment) -> TabStop

Sets this tab stop’s alignment and returns it for chaining.

Examples found in repository

examples/docx_text_formatting.rs (line 63)

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

    let document = Document::new()
        .with_paragraph(heading("Docx text formatting — bold, italic, underline, strike", false))
        .with_paragraph(Paragraph::new().with_run(Run::new("Bold text.").with_bold(true)))
        .with_paragraph(Paragraph::new().with_run(Run::new("Italic text.").with_italic(true)))
        .with_paragraph(Paragraph::new().with_run(Run::new("Single underline.").with_underline(UnderlineStyle::Single)))
        .with_paragraph(Paragraph::new().with_run(Run::new("Wavy underline.").with_underline(UnderlineStyle::Wave)))
        .with_paragraph(Paragraph::new().with_run(Run::new("Strikethrough text.").with_strike(true)))
        .with_paragraph(heading("Colors and highlight", true))
        .with_paragraph(Paragraph::new().with_run(Run::new("Red text on the default background.").with_color("FF0000")))
        .with_paragraph(Paragraph::new().with_run(Run::new("Text highlighted in yellow.").with_highlight(Highlight::Yellow)))
        .with_paragraph(
            Paragraph::new()
                .with_run(Run::new("Larger, custom font.").with_font_size(32).with_font_family("Georgia")),
        )
        .with_paragraph(heading("Superscript and subscript", true))
        .with_paragraph(
            Paragraph::new()
                .with_run(Run::new("Water is H"))
                .with_run(Run::new("2").with_vertical_align(VerticalAlign::Subscript))
                .with_run(Run::new("O.")),
        )
        .with_paragraph(
            Paragraph::new()
                .with_run(Run::new("Squared: x"))
                .with_run(Run::new("2").with_vertical_align(VerticalAlign::Superscript))
                .with_run(Run::new(".")),
        )
        .with_paragraph(heading("Small caps, all caps, character spacing", true))
        .with_paragraph(Paragraph::new().with_run(Run::new("rendered in small caps").with_small_caps(true)))
        .with_paragraph(Paragraph::new().with_run(Run::new("rendered in all caps").with_all_caps(true)))
        .with_paragraph(Paragraph::new().with_run(Run::new("Widely spaced letters.").with_character_spacing(120)))
        .with_paragraph(heading("Paragraph alignment", true))
        .with_paragraph(Paragraph::with_text("Left-aligned (the default).").with_alignment(Alignment::Left))
        .with_paragraph(Paragraph::with_text("Centered.").with_alignment(Alignment::Center))
        .with_paragraph(Paragraph::with_text("Right-aligned.").with_alignment(Alignment::Right))
        .with_paragraph(
            Paragraph::with_text(
                "Justified: this line is long enough for Word to stretch the spacing between words so both edges line up.",
            )
            .with_alignment(Alignment::Justify),
        )
        .with_paragraph(heading("Tab stops", true))
        .with_paragraph(
            Paragraph::new()
                .with_tab(TabStop::new(1_440).with_alignment(TabStopAlignment::Center))
                .with_tab(TabStop::new(2_880).with_alignment(TabStopAlignment::Right).with_leader(TabLeader::Dot))
                .with_run(Run::new("Left\tCentered\tRight, dot leader")),
        );

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

pub fn with_leader(self, leader: TabLeader) -> TabStop

Sets this tab stop’s leader character and returns it for chaining.

Examples found in repository

examples/docx_text_formatting.rs (line 64)

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

    let document = Document::new()
        .with_paragraph(heading("Docx text formatting — bold, italic, underline, strike", false))
        .with_paragraph(Paragraph::new().with_run(Run::new("Bold text.").with_bold(true)))
        .with_paragraph(Paragraph::new().with_run(Run::new("Italic text.").with_italic(true)))
        .with_paragraph(Paragraph::new().with_run(Run::new("Single underline.").with_underline(UnderlineStyle::Single)))
        .with_paragraph(Paragraph::new().with_run(Run::new("Wavy underline.").with_underline(UnderlineStyle::Wave)))
        .with_paragraph(Paragraph::new().with_run(Run::new("Strikethrough text.").with_strike(true)))
        .with_paragraph(heading("Colors and highlight", true))
        .with_paragraph(Paragraph::new().with_run(Run::new("Red text on the default background.").with_color("FF0000")))
        .with_paragraph(Paragraph::new().with_run(Run::new("Text highlighted in yellow.").with_highlight(Highlight::Yellow)))
        .with_paragraph(
            Paragraph::new()
                .with_run(Run::new("Larger, custom font.").with_font_size(32).with_font_family("Georgia")),
        )
        .with_paragraph(heading("Superscript and subscript", true))
        .with_paragraph(
            Paragraph::new()
                .with_run(Run::new("Water is H"))
                .with_run(Run::new("2").with_vertical_align(VerticalAlign::Subscript))
                .with_run(Run::new("O.")),
        )
        .with_paragraph(
            Paragraph::new()
                .with_run(Run::new("Squared: x"))
                .with_run(Run::new("2").with_vertical_align(VerticalAlign::Superscript))
                .with_run(Run::new(".")),
        )
        .with_paragraph(heading("Small caps, all caps, character spacing", true))
        .with_paragraph(Paragraph::new().with_run(Run::new("rendered in small caps").with_small_caps(true)))
        .with_paragraph(Paragraph::new().with_run(Run::new("rendered in all caps").with_all_caps(true)))
        .with_paragraph(Paragraph::new().with_run(Run::new("Widely spaced letters.").with_character_spacing(120)))
        .with_paragraph(heading("Paragraph alignment", true))
        .with_paragraph(Paragraph::with_text("Left-aligned (the default).").with_alignment(Alignment::Left))
        .with_paragraph(Paragraph::with_text("Centered.").with_alignment(Alignment::Center))
        .with_paragraph(Paragraph::with_text("Right-aligned.").with_alignment(Alignment::Right))
        .with_paragraph(
            Paragraph::with_text(
                "Justified: this line is long enough for Word to stretch the spacing between words so both edges line up.",
            )
            .with_alignment(Alignment::Justify),
        )
        .with_paragraph(heading("Tab stops", true))
        .with_paragraph(
            Paragraph::new()
                .with_tab(TabStop::new(1_440).with_alignment(TabStopAlignment::Center))
                .with_tab(TabStop::new(2_880).with_alignment(TabStopAlignment::Right).with_leader(TabLeader::Dot))
                .with_run(Run::new("Left\tCentered\tRight, dot leader")),
        );

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

Trait Implementations

impl Clone for TabStop

fn clone(&self) -> TabStop

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for TabStop

impl Debug for TabStop

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

Formats the value using the given formatter.

impl Eq for TabStop

impl PartialEq for TabStop

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for TabStop