Struct DefinedName 

pub struct DefinedName {
    pub name: String,
    pub refers_to: String,
    pub local_sheet_id: Option<usize>,
    pub hidden: bool,
    pub comment: Option<String>,
}

A named range/formula/constant (<definedName>, CT_DefinedName) — unlike ConditionalFormattingRule/DataValidationRule, this is a workbook-level construct, not attached to any particular Sheet, even when local_sheet_id scopes it to one.

Only name/refers_to/local_sheet_id/hidden/comment are modeled. CT_DefinedName’s remaining attributes (function/ vbProcedure/xlm/functionGroupId/shortcutKey/publishToServer/ workbookParameter/customMenu/description/help/statusBar) are all macro/add-in/UI-text concerns with no real demand seen yet, same scope-reduction posture as elsewhere in this crate. SpreadsheetML’s reserved _xlnm.* built-in names (print area, print titles, filter database..) aren’t given any special handling — a caller can write one like any other name, but nothing here validates or treats it specially.

Fields

name: String

The name shown in Excel’s Name Manager (name, required).

refers_to: String

The formula, range reference, or constant this name refers to (e.g. "Feuil1!$A$1:$B$10"), written as the element’s own text content — unlike a conditional formatting/data validation rule’s formula, CT_DefinedName has simple content (ST_Formula), not a dedicated child element.

local_sheet_id: Option<usize>

If Some, scopes this name to a single sheet rather than the whole workbook (localSheetId, a 0-based index into Workbook.sheets in declaration order) — a sheet-scoped name can be duplicated across different sheets’ scopes, unlike a workbook-scoped one. None means workbook-wide scope, the common case.

hidden: bool

Whether this name is hidden in Excel’s Name Manager UI (hidden).

comment: Option<String>

An optional comment shown for this name (comment).

Implementations

impl DefinedName

pub fn new(name: impl Into<String>, refers_to: impl Into<String>) -> DefinedName

Creates a workbook-scoped defined name, not hidden, no comment.

Examples found in repository

examples/xlsx_workbook_metadata.rs (line 54)

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

    let named_ranges_sheet = Sheet::new("Named ranges")
        .with_row(Row::new().with_text("Tax rate").with_number(0.0825))
        .with_row(Row::new().with_cell(Cell::formula("TaxRate*100").with_cached_value(8.25)));

    let calculation_sheet = Sheet::new("Calculation").with_row(
        Row::new().with_text("Set to manual recalculation with iterative calculation enabled."),
    );

    let scenarios_sheet = Sheet::new("Scenarios")
        .with_row(Row::new().with_text("Revenue").with_number(100_000.0))
        .with_row(Row::new().with_text("Cost").with_number(60_000.0))
        .with_scenario(
            Scenario::new("Best case")
                .with_input("B1", "150000")
                .with_input("B2", "55000")
                .with_comment("Optimistic projection"),
        )
        .with_scenario(
            Scenario::new("Worst case")
                .with_input("B1", "70000")
                .with_input("B2", "65000"),
        );

    let auto_filter_sheet = Sheet::new("Autofilter criteria")
        .with_row(Row::new().with_text("Region"))
        .with_row(Row::new().with_text("North"))
        .with_row(Row::new().with_text("South"))
        .with_auto_filter_range("A1:A3")
        .with_auto_filter_column(AutoFilterColumn::new(0, vec!["North".to_string()]));

    let ignored_errors_sheet = Sheet::new("Ignored errors")
        .with_row(Row::new().with_text("123")) // a number stored as text — normally flagged by Excel
        .with_ignored_error(IgnoredError::new("A1:A1").with_number_stored_as_text(true));

    let workbook = Workbook::new()
        .with_defined_name(DefinedName::new("TaxRate", "'Named ranges'!$B$1"))
        .with_calculation(
            CalculationProperties::new()
                .with_mode(CalculationMode::Manual)
                .with_iterate(true),
        )
        .with_sheet(named_ranges_sheet)
        .with_sheet(calculation_sheet)
        .with_sheet(scenarios_sheet)
        .with_sheet(auto_filter_sheet)
        .with_sheet(ignored_errors_sheet);

    // `Workbook.properties` has no `with_*` builder — it's set directly,
    // like any other public field.
    let properties = DocumentProperties::new()
        .with_title("Metadata example")
        .with_author("Example Author")
        .with_subject("Workbook-level features")
        .with_custom_property(
            "ProjectCode",
            CustomPropertyValue::Text("XLSX-META".to_string()),
        );
    let workbook = Workbook {
        properties,
        ..workbook
    };

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

pub fn with_local_sheet_id(self, local_sheet_id: usize) -> DefinedName

Scopes this name to a single sheet (by its 0-based position in Workbook.sheets) and returns it for chaining.

pub fn with_hidden(self, hidden: bool) -> DefinedName

Sets whether this name is hidden in Excel’s Name Manager and returns it for chaining.

pub fn with_comment(self, comment: impl Into<String>) -> DefinedName

Sets this name’s comment and returns it for chaining.

Trait Implementations

impl Clone for DefinedName

fn clone(&self) -> DefinedName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DefinedName

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

Formats the value using the given formatter.

impl PartialEq for DefinedName

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DefinedName