GrapeCity.Documents.Excel.IScenario

Interface IScenario

A scenario is a group of input values (called changing cells) that's named and saved.

public interface IScenario

Returns a IRange object that represents the changing cells for the scenario. Read-only.

IRange ChangingCells { get; }

Returns or sets a String value that represents the comment associated with the scenario.

string Comment { get; set; }

Gets or sets a Boolean value that indicates if the scenario is hidden.

bool Hidden { get; set; }

Returns the index number of the object within the collection of similar objects.

int Index { get; }

Gets or sets a Boolean value that indicates if the scenario is locked.

bool Locked { get; set; }

Gets or sets a String value representing the name of the object.

string Name { get; set; }

Returns a list that contains the current values of the changing cells for the scenario. Read-only.

IList<object> Values { get; }

Changes the scenario to have a new set of changing cells and (optionally) scenario values.

void ChangeScenario(IRange changingCells, List<object> values = null)

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.

Deletes the object.

void Delete()

Shows the scenario by inserting its values on the worksheet. The affected cells are the changing cells of the scenario.

void Show()