Struct TableColumn 

pub struct TableColumn {
    pub name: String,
    pub calculated_formula: Option<String>,
    pub totals_row_function: Option<TotalsRowFunction>,
    pub totals_row_label: Option<String>,
    pub totals_row_formula: Option<String>,
}

One column of an ExcelTable (<tableColumn>, CT_TableColumn) — (plain name only), extended for calculated_formula/ totals_row_function/totals_row_label.

Fields

name: String

The column’s name, matching the header row’s actual cell text (see ExcelTable::columns’s doc comment).

calculated_formula: Option<String>

This column’s calculated-column formula (<calculatedColumnFormula>), if any. Declaring a column calculated in the table definition only; this crate does not automatically propagate a <f> formula onto every data row’s cell in this column — the caller remains responsible for each data row’s own cell actually carrying a matching CellValue::Formula if the per-row formulas should appear too (storage only, same “caller keeps things in sync” posture as ExcelTable::columns itself).

Structured references must use the fully-qualified/expanded form, TableName[[#This Row],[ColumnName]] — not the shorthand [@ColumnName]. Both are valid Excel syntax when typed into the UI (Excel silently normalizes one to the other), but a real Excel installation rejects and strips the whole <table> on open when the shorthand form is what ends up stored verbatim in calculatedColumnFormula (and/or a data row’s own <f>) — a genuine Excel-authored file stores exactly this expanded form (Table1[[#This Row],[ColumnName]]) rather than [@ColumnName]. This crate does not rewrite or validate formula text — passing a shorthand structured reference here silently produces a file real Excel repairs on open.

totals_row_function: Option<TotalsRowFunction>

This column’s totals-row aggregate function (<tableColumn totalsRowFunction="..">), if any. Meaningless unless ExcelTable::show_totals_row is also true. Writes only the totalsRowFunction=".." attribute itself on <tableColumn> — unlike an earlier version of this crate, it does not auto-generate a matching <totalsRowFormula>SUBTOTAL(n,[ColumnName])</totalsRowFormula> table-metadata child element for a built-in function anymore: real Excel never writes that particular child element either (the function name alone determines what it computes internally).

This is a separate thing from the totals row’s own cell in sheetData, which the caller remains responsible for (same “caller keeps things in sync” posture as calculated_formula): real Excel’s own totals row is a genuine formula cell, not a plain cached number — confirmed against a real Excel-authored file, whose totals row cell for a sum column literally contains <f>SUBTOTAL(109,TableName[ColumnName])</f> with a cached <v>, and for average, <f>SUBTOTAL(101,TableName[ColumnName])</f>. The 10x-prefixed SUBTOTAL function codes (ignoring manually-hidden rows) real Excel tables use are, in TotalsRowFunction order: Average → 101, Count → 102, CountNums → 103, Max → 104, Min → 105, StdDev → 107, Var → 110, Sum → 109 (Custom has no fixed code — the caller supplies totals_row_formula directly instead). A totals row cell left as a plain cached number instead of this formula is one of the concrete differences from real Excel output that causes a real Excel installation to reject and repair the file. Only TotalsRowFunction::Custom pairs with an explicit totals_row_formula. Also see totals_row_label’s doc comment: setting both on the same column, this field is silently dropped at write time.

totals_row_label: Option<String>

This column’s totals-row label (<tableColumn totalsRowLabel="..">), shown instead of a computed value — typically only meaningful on the first column of a totals row (e.g. "Total"). The same real Excel-authored reference file mentioned in totals_row_function’s doc comment also shows that the totals row’s own cell for the label column carries the label text itself as a plain string value too (redundant with this attribute, but present) — the caller remains responsible for that cell’s actual value matching. Mutually exclusive with totals_row_function on the same column and enforced by the writer (real Excel’s own UI only ever offers one or the other per column): when both are set here, the label wins and totals_row_function/totals_row_formula are simply not written for that column.

totals_row_formula: Option<String>

This column’s literal totals-row formula text (<totalsRowFormula>), only written when totals_row_function is TotalsRowFunction::Custom and totals_row_label is None — every other function variant writes no <totalsRowFormula> at all (see totals_row_function’s doc comment), and a label on the same column takes priority over both (see totals_row_label’s doc comment). If this formula uses a structured reference, see calculated_formula’s doc comment: use the expanded TableName[[#This Row],[ColumnName]] form, not [@ColumnName].

Implementations

impl TableColumn

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

Creates a plain column with no calculated formula or totals-row function yet.

Examples found in repository

examples/xlsx_tables.rs (line 57)

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_calculated_formula(self, formula: impl Into<String>) -> TableColumn

Sets this column’s calculated-column formula and returns it for chaining.

Examples found in repository

examples/xlsx_tables.rs (lines 61-63)

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_totals_row_function( self, function: TotalsRowFunction, ) -> TableColumn

Sets this column’s totals-row aggregate function and returns it for chaining.

Examples found in repository

examples/xlsx_tables.rs (line 58)

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_totals_row_label(self, label: impl Into<String>) -> TableColumn

Sets this column’s totals-row label and returns it for chaining.

pub fn with_totals_row_formula(self, formula: impl Into<String>) -> TableColumn

Sets this column’s literal totals-row formula text (only used when totals_row_function is TotalsRowFunction::Custom) and returns it for chaining.

Trait Implementations

impl Clone for TableColumn

fn clone(&self) -> TableColumn

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TableColumn

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

Formats the value using the given formatter.

impl PartialEq for TableColumn

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for TableColumn