Scenario Class

Scenario.When the object is serialized out as xml, its qualified name is x:scenario.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlCompositeElement
      DocumentFormat.OpenXml.Spreadsheet.Scenario

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

Syntax

'Declaration
<ChildElementInfoAttribute(GetType(InputCells))> _
Public Class Scenario _
    Inherits OpenXmlCompositeElement
'Usage
Dim instance As Scenario
[ChildElementInfoAttribute(typeof(InputCells))]
public class Scenario : OpenXmlCompositeElement

Remarks

The following table lists the possible child types:

  • InputCells <x:inputCells>

[ISO/IEC 29500-1 1st Edition]

18.3.1.75 scenario (Scenario)

An individual scenario description. [Note: See parent element for an example. end note]

Parent Elements

scenarios (§18.3.1.76)

Child Elements

Subclause

inputCells (Input Cells)

§18.3.1.52

Attributes

Description

comment (Scenario Comment)

Comment for this scenario, rich text not supported.

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

count (Changing Cell Count)

Number of input cells.

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

hidden (Hidden Scenario)

Scenario is hidden when the sheet is protected and 'edit scenarios' is not enabled in sheet protection options. If the scenario is marked as hidden but sheet protection options specify to allow editing scenarios, then the scenario shall not be hidden.

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

locked (Scenario Locked)

Scenario is locked for editing when the sheet is protected. If sheet is protected and "edit scenarios" is enabled, then this setting is ignored.

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

name (Scenario Name)

Scenario's name (user input). Shall be unique for the workbook.

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

user (User Name)

Name of user who last changed the scenario.

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

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

© ISO/IEC29500: 2008.

Thread Safety

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

See Also

Reference

Scenario Members

DocumentFormat.OpenXml.Spreadsheet Namespace