Scenarios class

Office 2013 and later

Defines the Scenarios Class. When the object is serialized out as xml, its qualified name is x:scenarios.

Namespace:  DocumentFormat.OpenXml.Spreadsheet
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

C#
VB
C++
Copy
No code example is currently available or this language may not be supported.

[ISO/IEC 29500-1 1st Edition]

scenarios (Scenarios)

A collection of Scenarios. A scenario is a named what-if model that includes variable cells linked together by one or more formulas.

[Example: For example, you might want to compare best-case and worst-case scenarios for sales in a coffee shop, based on the number of cups of coffee sold in a week.

<scenarios current="1" show="0" sqref="G4 G6 G7 G8">
  <scenario name="Best Case" locked="1" count="3" user="anonymous"     comment="Created on _x000a_Modified on ">
    <inputCells r="D5" val="151" numFmtId="37"/>
    <inputCells r="D9" val="226"/>
    <inputCells r="D13" val="126"/>
  </scenario>
  <scenario name="Worst Case" locked="1" count="3" user="anonymous"    comment="Created on ">
    <inputCells r="D5" val="50" numFmtId="37"/>
    <inputCells r="D9" val="40"/>
    <inputCells r="D13" val="30"/>
  </scenario>
</scenarios>

end example]

Parent Elements

worksheet (§18.3.1.99)

Child Elements

Subclause

scenario (Scenario)

§18.3.1.75

Attributes

Description

current (Current Scenario)

Zero-based index to current scenario selected. Can correspond to selection UI.

The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.

show (Last Shown Scenario)

Zero-based index to last shown scenario. Indicates which scenario was last selected by the user to be run/shown.

The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.

sqref (Sequence of References)

Range or sequence of cells used for scenario results summary.

The possible values for this attribute are defined by the ST_Sqref simple type (§18.18.76).

[Note: The W3C XML Schema definition of this element’s content model (CT_Scenarios) is located in §A.2. end note]

© ISO/IEC29500: 2008.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show: