GrapeCity.Documents.Excel.IScenarios

Interface IScenarios

Namespace

GrapeCity.Documents.Excel

Assembly

GcDocs.Excel.dll

Represents the collection of IScenario objects in the worksheet.

public interface IScenarios : IEnumerable

Inherited Members

IEnumerable.GetEnumerator()

Properties

Count

Returns the number of objects in the collection.

int Count { get; }

Property Value

int

this[int]

Gets the scenario using the index.

IScenario this[int index] { get; }

Parameters

index int

The index.

Property Value

IScenario

this[string]

Gets the scenario using the name.

IScenario this[string name] { get; }

Parameters

name string

The scenario name.

Property Value

IScenario

Methods

Add(string, IRange, List<object>, string, bool, bool)

Creates a new scenario and adds it to the list of scenarios in the current worksheet.

IScenario Add(string name, IRange changingCells, List<object> values = null, string comment = null, bool locked = true, bool hidden = false)

Parameters

name string

The scenario name.

changingCells IRange

A Range object that refers to the changing cells for the scenario.

values List<object>

A list that contains the scenario values for the cells in ChangingCells. If this argument is omitted, the scenario values are assumed to be the current values in the cells in ChangingCells.

comment string

A string that specifies comment text for the scenario. If this argument is omitted, the author's name(Document Solutions for Excel) and date are automatically added as the comment text.

locked bool

True to lock the scenario to prevent changes. The default value is True.

hidden bool

True to hide the scenario. The default value is False.

Returns

IScenario

Returns the new IScenario object.