• DR-IT Software
  • Products
  • Documentation
  • Product page
  • Examples
  • API reference
  • Support
Show / Hide Table of Contents

Class ScenarioCollection

Represents the scenario collection class used by the spreadsheet model.

Inheritance
object
ScenarioCollection
Implements
IEnumerable<Scenario>
IEnumerable
Inherited Members
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
Namespace: DRIT.Spreadsheet
Assembly: DRIT.Spreadsheet.dll
Syntax
public class ScenarioCollection : IEnumerable<Scenario>, IEnumerable

Properties

Count

Reports the number of items currently held by ScenarioCollection.

Declaration
public int Count { get; }
Property Value
Type Description
int

The count returned by the operation.

CurrentScenario

Zero-based index to current scenario selected.

Declaration
public int? CurrentScenario { get; set; }
Property Value
Type Description
int?

this[int]

Provides indexed access to values in ScenarioCollection.

Declaration
public Scenario this[int index] { get; }
Parameters
Type Name Description
int index
Property Value
Type Description
Scenario

LastShownScenario

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

Declaration
public int? LastShownScenario { get; set; }
Property Value
Type Description
int?

Range

Exposes the range associated with ScenarioCollection.

Declaration
public Range Range { get; set; }
Property Value
Type Description
Range

Methods

Add(Scenario)

Adds the supplied item to ScenarioCollection.

Declaration
public void Add(Scenario item)
Parameters
Type Name Description
Scenario item

The item used by the operation.

Clear()

Exposes the clear associated with ScenarioCollection.

Declaration
public void Clear()

GetEnumerator()

Retrieves the requested enumerator from ScenarioCollection.

Declaration
public IEnumerator<Scenario> GetEnumerator()
Returns
Type Description
IEnumerator<Scenario>

The get enumerator returned by the operation.

Remove(Scenario)

Removes the selected item from ScenarioCollection.

Declaration
public bool Remove(Scenario item)
Parameters
Type Name Description
Scenario item

The item used by the operation.

Returns
Type Description
bool

The remove returned by the operation.

RemoveAt(int)

Removes the selected at from ScenarioCollection.

Declaration
public void RemoveAt(int index)
Parameters
Type Name Description
int index

The index used by the operation.

Implements

IEnumerable<T>
IEnumerable
Back to top

DR-IT Software documentation

DR-IT Software · Products · Documentation index · Product page · Downloads · Support · Licensing

Generated by DocFX