Struct IgnoredError 

pub struct IgnoredError {
    pub range: String,
    pub number_stored_as_text: bool,
    pub formula_range: bool,
    pub formula: bool,
    pub unlocked_formula: bool,
    pub empty_cell_reference: bool,
    pub list_data_validation: bool,
    pub calculated_column: bool,
    pub two_digit_text_year: bool,
    pub eval_error: bool,
}

A suppressed error-checking indicator over one range (<ignoredError>, CT_IgnoredError). Confirmed against sml.xsd (CT_IgnoredErrors/CT_IgnoredError, ECMA-376 SpreadsheetML): sqref is the only required attribute, every error-category flag is an optional boolean defaulting to false. This crate models every flag CT_IgnoredError defines; real Excel’s own “Ignore Error” right-click menu only ever sets one flag at a time per range, but nothing in the schema forbids several flags on the same entry, so this type allows it too (caller’s choice, same “don’t second-guess the caller” posture as ConditionalFormattingRule).

Fields

range: String

The range this entry covers (sqref, e.g. "B2:B10" or a single cell "C4") — like ConditionalFormattingRule::range, several disjoint cells can be packed into one sqref (space-separated) if the caller wants a single entry to cover them; this crate writes the string verbatim, no validation.

number_stored_as_text: bool

Suppresses the “number stored as text” warning — by far the most common real-world use of <ignoredError> (e.g. a column of ZIP codes or reference numbers intentionally kept as text).

formula_range: bool

Suppresses the “formula omits adjacent cells” warning.

formula: bool

Suppresses the “inconsistent formula” warning (a formula that differs from the pattern of its neighboring cells).

unlocked_formula: bool

Suppresses the “unlocked cell containing a formula” warning.

empty_cell_reference: bool

Suppresses the “formula refers to an empty cell” warning.

list_data_validation: bool

Suppresses the “value fails a list data validation rule” warning.

calculated_column: bool

Suppresses the “table’s calculated column formula is inconsistent” warning.

two_digit_text_year: bool

Suppresses the “text year is ambiguous” warning (a two-digit year entered in a text-formatted cell).

eval_error: bool

Suppresses the “formula results in an error” warning (e.g. a deliberate #N/A or #DIV/0!).

Implementations

impl IgnoredError

pub fn new(range: impl Into<String>) -> IgnoredError

Creates an ignored-error entry over range with every flag unset — use the with_* builders to enable the specific warning(s) to suppress.

Examples found in repository

examples/xlsx_workbook_metadata.rs (line 51)

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_number_stored_as_text(self, value: bool) -> IgnoredError

Suppresses the “number stored as text” warning and returns the entry for chaining — the common case (see this type’s own doc comment).

Examples found in repository

examples/xlsx_workbook_metadata.rs (line 51)

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_formula_range(self, value: bool) -> IgnoredError

Suppresses the “formula omits adjacent cells” warning and returns the entry for chaining.

pub fn with_formula(self, value: bool) -> IgnoredError

Suppresses the “inconsistent formula” warning and returns the entry for chaining.

pub fn with_unlocked_formula(self, value: bool) -> IgnoredError

Suppresses the “unlocked cell containing a formula” warning and returns the entry for chaining.

pub fn with_empty_cell_reference(self, value: bool) -> IgnoredError

Suppresses the “formula refers to an empty cell” warning and returns the entry for chaining.

pub fn with_list_data_validation(self, value: bool) -> IgnoredError

Suppresses the “value fails a list data validation rule” warning and returns the entry for chaining.

pub fn with_calculated_column(self, value: bool) -> IgnoredError

Suppresses the “table’s calculated column formula is inconsistent” warning and returns the entry for chaining.

pub fn with_two_digit_text_year(self, value: bool) -> IgnoredError

Suppresses the “text year is ambiguous” warning and returns the entry for chaining.

pub fn with_eval_error(self, value: bool) -> IgnoredError

Suppresses the “formula results in an error” warning and returns the entry for chaining.

Trait Implementations

impl Clone for IgnoredError

fn clone(&self) -> IgnoredError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IgnoredError

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

Formats the value using the given formatter.

impl PartialEq for IgnoredError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for IgnoredError