Struct TableStyle 

pub struct TableStyle {
    pub name: String,
    pub elements: Vec<TableStyleElement>,
}

A custom table style definition (<tableStyle>, CT_TableStyle), declared workbook-wide in xl/styles.xml’s <tableStyles> (CT_TableStyles) and referenced by name from an ExcelTable’s own table_style_name. Confirmed against sml.xsd: CT_Stylesheet’s own sequence puts tableStyles right after dxfs, before colors (not written by this crate). This crate only ever writes pivot="0" (this style is for tables, not pivot tables) and no count attribute (CT_TableStyle’s count is informational, Excel recomputes it).

Fields

name: String

This style’s name, referenced by ExcelTable::table_style_name (must be unique within the workbook, not validated here — a name colliding with one of Excel’s own dozens of built-in style names, e.g. "TableStyleMedium2", silently shadows the built-in one for this workbook).

elements: Vec<TableStyleElement>

The banding/region formats making up this style, in no particular required order (real Excel itself doesn’t enforce one either).

Implementations

impl TableStyle

pub fn new(name: impl Into<String>) -> TableStyle

Creates a named table style with no elements yet.

Examples found in repository

examples/xlsx_tables.rs (line 85)

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

    let plain_sheet = Sheet::new("Plain table")
        .with_row(Row::new().with_text("Name").with_text("Score"))
        .with_row(Row::new().with_text("Alice").with_number(92.0))
        .with_row(Row::new().with_text("Bob").with_number(87.0))
        .with_table(ExcelTable::new(
            "ScoresTable",
            "A1:B3",
            vec!["Name", "Score"],
        ));

    let calculated_sheet = Sheet::new("Calculated and totals")
        .with_row(
            Row::new()
                .with_text("Item")
                .with_text("Qty")
                .with_text("Unit price")
                .with_text("Line total"),
        )
        .with_row(
            Row::new()
                .with_text("Widget")
                .with_number(3.0)
                .with_number(9.99)
                .with_cell(Cell::formula("B2*C2").with_cached_value(29.97)),
        )
        .with_row(
            Row::new()
                .with_text("Gadget")
                .with_number(2.0)
                .with_number(19.99)
                .with_cell(Cell::formula("B3*C3").with_cached_value(39.98)),
        )
        .with_row(Row::new().with_cell(Cell::text("Total")))
        .with_table(
            ExcelTable::with_columns(
                "OrdersTable",
                "A1:D4",
                vec![
                    TableColumn::new("Item"),
                    TableColumn::new("Qty").with_totals_row_function(TotalsRowFunction::Sum),
                    TableColumn::new("Unit price"),
                    TableColumn::new("Line total")
                        .with_calculated_formula(
                            "OrdersTable[[#This Row],[Qty]]*OrdersTable[[#This Row],[Unit price]]",
                        )
                        .with_totals_row_function(TotalsRowFunction::Sum),
                ],
            )
            .with_totals_row(true),
        );

    let styled_sheet = Sheet::new("Custom style and sort")
        .with_row(Row::new().with_text("City").with_text("Population"))
        .with_row(Row::new().with_text("Springfield").with_number(120_000.0))
        .with_row(Row::new().with_text("Shelbyville").with_number(95_000.0))
        .with_table(
            ExcelTable::new("CitiesTable", "A1:B3", vec!["City", "Population"])
                .with_table_style_name("CustomTableStyle")
                .with_sort_state(
                    SortState::new("A2:B3")
                        .with_condition(SortCondition::new("B2:B3").with_descending(true)),
                ),
        );

    let workbook = Workbook::new()
        .with_table_style(
            TableStyle::new("CustomTableStyle")
                .with_element(TableStyleElement::new(
                    TableStyleElementType::HeaderRow,
                    CellFormat::new()
                        .with_bold(true)
                        .with_fill_color("FF2E74B5")
                        .with_font_color("FFFFFFFF"),
                ))
                .with_element(TableStyleElement::new(
                    TableStyleElementType::FirstRowStripe,
                    CellFormat::new().with_fill_color("FFF2F2F2"),
                )),
        )
        .with_sheet(plain_sheet)
        .with_sheet(calculated_sheet)
        .with_sheet(styled_sheet);

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

pub fn with_element(self, element: TableStyleElement) -> TableStyle

Appends a formatted element and returns the style for chaining.

Examples found in repository

examples/xlsx_tables.rs (lines 86-92)

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

    let plain_sheet = Sheet::new("Plain table")
        .with_row(Row::new().with_text("Name").with_text("Score"))
        .with_row(Row::new().with_text("Alice").with_number(92.0))
        .with_row(Row::new().with_text("Bob").with_number(87.0))
        .with_table(ExcelTable::new(
            "ScoresTable",
            "A1:B3",
            vec!["Name", "Score"],
        ));

    let calculated_sheet = Sheet::new("Calculated and totals")
        .with_row(
            Row::new()
                .with_text("Item")
                .with_text("Qty")
                .with_text("Unit price")
                .with_text("Line total"),
        )
        .with_row(
            Row::new()
                .with_text("Widget")
                .with_number(3.0)
                .with_number(9.99)
                .with_cell(Cell::formula("B2*C2").with_cached_value(29.97)),
        )
        .with_row(
            Row::new()
                .with_text("Gadget")
                .with_number(2.0)
                .with_number(19.99)
                .with_cell(Cell::formula("B3*C3").with_cached_value(39.98)),
        )
        .with_row(Row::new().with_cell(Cell::text("Total")))
        .with_table(
            ExcelTable::with_columns(
                "OrdersTable",
                "A1:D4",
                vec![
                    TableColumn::new("Item"),
                    TableColumn::new("Qty").with_totals_row_function(TotalsRowFunction::Sum),
                    TableColumn::new("Unit price"),
                    TableColumn::new("Line total")
                        .with_calculated_formula(
                            "OrdersTable[[#This Row],[Qty]]*OrdersTable[[#This Row],[Unit price]]",
                        )
                        .with_totals_row_function(TotalsRowFunction::Sum),
                ],
            )
            .with_totals_row(true),
        );

    let styled_sheet = Sheet::new("Custom style and sort")
        .with_row(Row::new().with_text("City").with_text("Population"))
        .with_row(Row::new().with_text("Springfield").with_number(120_000.0))
        .with_row(Row::new().with_text("Shelbyville").with_number(95_000.0))
        .with_table(
            ExcelTable::new("CitiesTable", "A1:B3", vec!["City", "Population"])
                .with_table_style_name("CustomTableStyle")
                .with_sort_state(
                    SortState::new("A2:B3")
                        .with_condition(SortCondition::new("B2:B3").with_descending(true)),
                ),
        );

    let workbook = Workbook::new()
        .with_table_style(
            TableStyle::new("CustomTableStyle")
                .with_element(TableStyleElement::new(
                    TableStyleElementType::HeaderRow,
                    CellFormat::new()
                        .with_bold(true)
                        .with_fill_color("FF2E74B5")
                        .with_font_color("FFFFFFFF"),
                ))
                .with_element(TableStyleElement::new(
                    TableStyleElementType::FirstRowStripe,
                    CellFormat::new().with_fill_color("FFF2F2F2"),
                )),
        )
        .with_sheet(plain_sheet)
        .with_sheet(calculated_sheet)
        .with_sheet(styled_sheet);

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

Trait Implementations

impl Clone for TableStyle

fn clone(&self) -> TableStyle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TableStyle

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

Formats the value using the given formatter.

impl PartialEq for TableStyle

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for TableStyle