Struct Border 

pub struct Border {
    pub top: Option<BorderEdge>,
    pub bottom: Option<BorderEdge>,
    pub left: Option<BorderEdge>,
    pub right: Option<BorderEdge>,
    pub diagonal: Option<BorderEdge>,
    pub diagonal_up: bool,
    pub diagonal_down: bool,
}

A cell’s borders (<border>, CT_Border) — up to four edges plus an optional diagonal. Border::default() (every field None/false) draws no border at all.

Fields

top: Option<BorderEdge>

bottom: Option<BorderEdge>

left: Option<BorderEdge>

right: Option<BorderEdge>

diagonal: Option<BorderEdge>

The diagonal line’s style/color — only drawn if diagonal_up and/or diagonal_down is also set (CT_Border’s own diagonalUp/diagonalDown attributes live on the parent <border> element, not <diagonal> itself).

diagonal_up: bool

Draws the diagonal from bottom-left to top-right.

diagonal_down: bool

Draws the diagonal from top-left to bottom-right.

Implementations

impl Border

pub fn new() -> Border

Creates a Border with no edges at all.

Examples found in repository

examples/xlsx_cell_formatting.rs (line 26)

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

    let borders_sheet =
        Sheet::new("Borders").with_row(
            Row::new()
                .with_cell(Cell::text("Thin all around").with_format(
                    CellFormat::new().with_border(Border::all(BorderStyle::Thin, "FF000000")),
                ))
                .with_cell(Cell::text("Thick bottom only").with_format(
                    CellFormat::new().with_border(
                        Border::new().with_bottom(
                            BorderEdge::new(BorderStyle::Thick).with_color("FFC00000"),
                        ),
                    ),
                )),
        );

    let fills_sheet = Sheet::new("Fills")
        .with_row(Row::new().with_cell(
            Cell::text("Solid fill").with_format(CellFormat::new().with_fill_color("FFFFF2CC")),
        ))
        .with_row(
            Row::new().with_cell(
                Cell::text("Pattern fill").with_format(
                    CellFormat::new().with_pattern_fill(
                        PatternFill::new(PatternType::LightGray)
                            .with_fg_color("FF4472C4")
                            .with_bg_color("FFFFFFFF"),
                    ),
                ),
            ),
        )
        .with_row(
            Row::new().with_cell(Cell::text("Gradient fill").with_format(
                CellFormat::new().with_gradient_fill(GradientFill::new(
                    90.0,
                    vec![
                        GradientStop::new(0.0, "FFFFFFFF"),
                        GradientStop::new(1.0, "FF4472C4"),
                    ],
                )),
            )),
        );

    let fonts_and_alignment_sheet =
        Sheet::new("Fonts and alignment")
            .with_row(
                Row::new().with_cell(
                    Cell::text("Bold, red, 14pt").with_format(
                        CellFormat::new()
                            .with_bold(true)
                            .with_font_size(14.0)
                            .with_font_color("FFC00000"),
                    ),
                ),
            )
            .with_row(
                Row::new().with_cell(
                    Cell::text("Centered both ways").with_format(
                        CellFormat::new()
                            .with_horizontal_alignment(HorizontalAlignment::Center)
                            .with_vertical_alignment(VerticalAlignment::Center),
                    ),
                ),
            )
            .with_row(Row::new().with_cell(
                Cell::text("Indented text").with_format(CellFormat::new().with_indent(2)),
            ));

    let number_formats_sheet = Sheet::new("Number formats")
        .with_row(Row::new().with_cell(
            Cell::number(1234.5).with_format(CellFormat::new().with_number_format("#,##0.00")),
        ))
        .with_row(Row::new().with_cell(
            Cell::number(0.0825).with_format(CellFormat::new().with_number_format("0.00%")),
        ))
        .with_row(Row::new().with_cell(
            Cell::number(1234.5).with_format(CellFormat::new().with_number_format("$#,##0.00")),
        ));

    let named_styles_sheet = Sheet::new("Named styles").with_row(
        Row::new().with_cell(
            Cell::text("Uses a named style")
                .with_format(CellFormat::new().with_named_style("Emphasis")),
        ),
    );

    let workbook = Workbook::new()
        .with_named_cell_style(NamedCellStyle::new(
            "Emphasis",
            CellFormat::new()
                .with_bold(true)
                .with_font_color("FF4472C4"),
        ))
        .with_sheet(borders_sheet)
        .with_sheet(fills_sheet)
        .with_sheet(fonts_and_alignment_sheet)
        .with_sheet(number_formats_sheet)
        .with_sheet(named_styles_sheet);

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

pub fn with_top(self, edge: BorderEdge) -> Border

Sets the top edge and returns the border for chaining.

pub fn with_bottom(self, edge: BorderEdge) -> Border

Sets the bottom edge and returns the border for chaining.

Examples found in repository

examples/xlsx_cell_formatting.rs (lines 26-28)

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

    let borders_sheet =
        Sheet::new("Borders").with_row(
            Row::new()
                .with_cell(Cell::text("Thin all around").with_format(
                    CellFormat::new().with_border(Border::all(BorderStyle::Thin, "FF000000")),
                ))
                .with_cell(Cell::text("Thick bottom only").with_format(
                    CellFormat::new().with_border(
                        Border::new().with_bottom(
                            BorderEdge::new(BorderStyle::Thick).with_color("FFC00000"),
                        ),
                    ),
                )),
        );

    let fills_sheet = Sheet::new("Fills")
        .with_row(Row::new().with_cell(
            Cell::text("Solid fill").with_format(CellFormat::new().with_fill_color("FFFFF2CC")),
        ))
        .with_row(
            Row::new().with_cell(
                Cell::text("Pattern fill").with_format(
                    CellFormat::new().with_pattern_fill(
                        PatternFill::new(PatternType::LightGray)
                            .with_fg_color("FF4472C4")
                            .with_bg_color("FFFFFFFF"),
                    ),
                ),
            ),
        )
        .with_row(
            Row::new().with_cell(Cell::text("Gradient fill").with_format(
                CellFormat::new().with_gradient_fill(GradientFill::new(
                    90.0,
                    vec![
                        GradientStop::new(0.0, "FFFFFFFF"),
                        GradientStop::new(1.0, "FF4472C4"),
                    ],
                )),
            )),
        );

    let fonts_and_alignment_sheet =
        Sheet::new("Fonts and alignment")
            .with_row(
                Row::new().with_cell(
                    Cell::text("Bold, red, 14pt").with_format(
                        CellFormat::new()
                            .with_bold(true)
                            .with_font_size(14.0)
                            .with_font_color("FFC00000"),
                    ),
                ),
            )
            .with_row(
                Row::new().with_cell(
                    Cell::text("Centered both ways").with_format(
                        CellFormat::new()
                            .with_horizontal_alignment(HorizontalAlignment::Center)
                            .with_vertical_alignment(VerticalAlignment::Center),
                    ),
                ),
            )
            .with_row(Row::new().with_cell(
                Cell::text("Indented text").with_format(CellFormat::new().with_indent(2)),
            ));

    let number_formats_sheet = Sheet::new("Number formats")
        .with_row(Row::new().with_cell(
            Cell::number(1234.5).with_format(CellFormat::new().with_number_format("#,##0.00")),
        ))
        .with_row(Row::new().with_cell(
            Cell::number(0.0825).with_format(CellFormat::new().with_number_format("0.00%")),
        ))
        .with_row(Row::new().with_cell(
            Cell::number(1234.5).with_format(CellFormat::new().with_number_format("$#,##0.00")),
        ));

    let named_styles_sheet = Sheet::new("Named styles").with_row(
        Row::new().with_cell(
            Cell::text("Uses a named style")
                .with_format(CellFormat::new().with_named_style("Emphasis")),
        ),
    );

    let workbook = Workbook::new()
        .with_named_cell_style(NamedCellStyle::new(
            "Emphasis",
            CellFormat::new()
                .with_bold(true)
                .with_font_color("FF4472C4"),
        ))
        .with_sheet(borders_sheet)
        .with_sheet(fills_sheet)
        .with_sheet(fonts_and_alignment_sheet)
        .with_sheet(number_formats_sheet)
        .with_sheet(named_styles_sheet);

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

pub fn with_left(self, edge: BorderEdge) -> Border

Sets the left edge and returns the border for chaining.

pub fn with_right(self, edge: BorderEdge) -> Border

Sets the right edge and returns the border for chaining.

pub fn with_diagonal(self, edge: BorderEdge, up: bool, down: bool) -> Border

Sets the diagonal edge and whether it runs bottom-left-to-top-right and/or top-left-to-bottom-right, and returns the border for chaining.

pub fn all(style: BorderStyle, color: impl Into<String>) -> Border

A convenience for the common case of the same style/color on all four sides (a full box border) — equivalent to calling with_top/with_bottom/ with_left/with_right with four identical edges.

Examples found in repository

examples/xlsx_cell_formatting.rs (line 22)

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

    let borders_sheet =
        Sheet::new("Borders").with_row(
            Row::new()
                .with_cell(Cell::text("Thin all around").with_format(
                    CellFormat::new().with_border(Border::all(BorderStyle::Thin, "FF000000")),
                ))
                .with_cell(Cell::text("Thick bottom only").with_format(
                    CellFormat::new().with_border(
                        Border::new().with_bottom(
                            BorderEdge::new(BorderStyle::Thick).with_color("FFC00000"),
                        ),
                    ),
                )),
        );

    let fills_sheet = Sheet::new("Fills")
        .with_row(Row::new().with_cell(
            Cell::text("Solid fill").with_format(CellFormat::new().with_fill_color("FFFFF2CC")),
        ))
        .with_row(
            Row::new().with_cell(
                Cell::text("Pattern fill").with_format(
                    CellFormat::new().with_pattern_fill(
                        PatternFill::new(PatternType::LightGray)
                            .with_fg_color("FF4472C4")
                            .with_bg_color("FFFFFFFF"),
                    ),
                ),
            ),
        )
        .with_row(
            Row::new().with_cell(Cell::text("Gradient fill").with_format(
                CellFormat::new().with_gradient_fill(GradientFill::new(
                    90.0,
                    vec![
                        GradientStop::new(0.0, "FFFFFFFF"),
                        GradientStop::new(1.0, "FF4472C4"),
                    ],
                )),
            )),
        );

    let fonts_and_alignment_sheet =
        Sheet::new("Fonts and alignment")
            .with_row(
                Row::new().with_cell(
                    Cell::text("Bold, red, 14pt").with_format(
                        CellFormat::new()
                            .with_bold(true)
                            .with_font_size(14.0)
                            .with_font_color("FFC00000"),
                    ),
                ),
            )
            .with_row(
                Row::new().with_cell(
                    Cell::text("Centered both ways").with_format(
                        CellFormat::new()
                            .with_horizontal_alignment(HorizontalAlignment::Center)
                            .with_vertical_alignment(VerticalAlignment::Center),
                    ),
                ),
            )
            .with_row(Row::new().with_cell(
                Cell::text("Indented text").with_format(CellFormat::new().with_indent(2)),
            ));

    let number_formats_sheet = Sheet::new("Number formats")
        .with_row(Row::new().with_cell(
            Cell::number(1234.5).with_format(CellFormat::new().with_number_format("#,##0.00")),
        ))
        .with_row(Row::new().with_cell(
            Cell::number(0.0825).with_format(CellFormat::new().with_number_format("0.00%")),
        ))
        .with_row(Row::new().with_cell(
            Cell::number(1234.5).with_format(CellFormat::new().with_number_format("$#,##0.00")),
        ));

    let named_styles_sheet = Sheet::new("Named styles").with_row(
        Row::new().with_cell(
            Cell::text("Uses a named style")
                .with_format(CellFormat::new().with_named_style("Emphasis")),
        ),
    );

    let workbook = Workbook::new()
        .with_named_cell_style(NamedCellStyle::new(
            "Emphasis",
            CellFormat::new()
                .with_bold(true)
                .with_font_color("FF4472C4"),
        ))
        .with_sheet(borders_sheet)
        .with_sheet(fills_sheet)
        .with_sheet(fonts_and_alignment_sheet)
        .with_sheet(number_formats_sheet)
        .with_sheet(named_styles_sheet);

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

Trait Implementations

impl Clone for Border

fn clone(&self) -> Border

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Border

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

Formats the value using the given formatter.

impl Default for Border

fn default() -> Border

Returns the “default value” for a type.

impl PartialEq for Border

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Border