Struct Scenario 

pub struct Scenario {
    pub name: String,
    pub inputs: Vec<(String, String)>,
    pub comment: Option<String>,
}

A “what-if” scenario (<scenario>, CT_Scenario). Represents one named “what if these cells held these values instead” snapshot, as managed through Excel’s own Data > What-If Analysis > Scenario Manager. This crate only stores the scenario’s definition (name/inputs/comment); it never evaluates the workbook under any scenario (same “storage, not evaluation” posture as formulas).

Fields

name: String

The scenario’s name, shown in Excel’s Scenario Manager.

inputs: Vec<(String, String)>

The cells this scenario overrides, as (cell reference, value text) pairs (<inputCells>/<inputCell r=".." val="..">) — val is written verbatim as text, matching CT_InputCells’s own xsd:string typing (Excel re-parses it as a number itself).

comment: Option<String>

An optional comment (comment).

Implementations

impl Scenario

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

Creates a scenario with no inputs yet, no comment.

Examples found in repository

examples/xlsx_workbook_metadata.rs (line 31)

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_input( self, cell: impl Into<String>, value: impl Into<String>, ) -> Scenario

Appends an input cell override and returns the scenario for chaining.

Examples found in repository

examples/xlsx_workbook_metadata.rs (line 32)

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_comment(self, comment: impl Into<String>) -> Scenario

Sets the scenario’s comment and returns it for chaining.

Examples found in repository

examples/xlsx_workbook_metadata.rs (line 34)

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(())
}

Trait Implementations

impl Clone for Scenario

fn clone(&self) -> Scenario

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Scenario

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

Formats the value using the given formatter.

impl PartialEq for Scenario

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Scenario