Struct NamedCellStyle 

pub struct NamedCellStyle {
    pub name: String,
    pub format: CellFormat,
    pub builtin_id: Option<u32>,
}

A named cell style (<cellStyle>/its paired <cellStyleXfs> <xf> entry, CT_CellStyle/CT_Xf), declared workbook-wide in xl/styles.xml and referenced from any CellFormat via CellFormat::named_style. This is Excel’s “Cell Styles” gallery: built-in entries like Good/Bad/ Neutral/Heading 1-4/Input/Output/Calculation/Currency/ Percent/Comma, or a caller’s own custom-named style. Confirmed against sml.xsd: CT_CellStyle’s only required attribute is xfId (this crate assigns it automatically, from this entry’s position in Workbook::named_cell_styles, mirroring how a dxfId/table-style dxfId is resolved rather than caller-supplied); name/builtinId are both optional but a real style always sets name at least (an unnamed entry would show as blank in Excel’s gallery, so name is required here, not Option).

Fields

name: String

This style’s name, shown in Excel’s Cell Styles gallery and referenced by CellFormat::named_style (must be unique within the workbook, not validated here).

format: CellFormat

The formatting this style applies (font/fill/border/number format/ alignment — the same CellFormat shape a regular cell format uses, written into its own dedicated cellStyleXfs entry rather than the shared cellXfs collection, mirroring how a dxf’s CellFormat is a separate index space too, see writer.rs::collect_dxfs’s doc comment).

builtin_id: Option<u32>

Identifies this as one of Excel’s own built-in styles rather than a caller-defined one (builtinId, e.g. 0 = "Normal", 3 = "Good", 4 = "Bad", 5 = "Neutral", 7-10 = "Heading 1"-"Heading 4". — ST_CellStyleBuiltinId’s full ~54-value table is not reproduced/validated here, this crate simply writes whatever u32 the caller supplies verbatim). None for a purely custom style with no built-in equivalent.

Implementations

impl NamedCellStyle

pub fn new(name: impl Into<String>, format: CellFormat) -> NamedCellStyle

Creates a named cell style with the given name and format, no built-in id (a purely custom style).

Examples found in repository

examples/xlsx_cell_formatting.rs (lines 104-109)

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_builtin_id(self, builtin_id: u32) -> NamedCellStyle

Sets the built-in id and returns the style for chaining.

Trait Implementations

impl Clone for NamedCellStyle

fn clone(&self) -> NamedCellStyle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NamedCellStyle

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

Formats the value using the given formatter.

impl PartialEq for NamedCellStyle

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for NamedCellStyle