Export (0) Print
Expand All
Expand Minimize

WorksheetBase.Scenarios Method

Gets an object that represents either a single scenario (a Microsoft.Office.Interop.Excel.Scenario object) or a collection of scenarios (a Microsoft.Office.Interop.Excel.Scenarios object) on the worksheet.

Namespace:  Microsoft.Office.Tools.Excel
Assembly:  Microsoft.Office.Tools.Excel.v4.0.Utilities (in Microsoft.Office.Tools.Excel.v4.0.Utilities.dll)

public Object Scenarios(
	Object index
)

Parameters

index
Type: System.Object

The name or number of the scenario. Use an array to specify more than one scenario.

Return Value

Type: System.Object
An object that represents either a single scenario (a Microsoft.Office.Interop.Excel.Scenario object) or a collection of scenarios (a Microsoft.Office.Interop.Excel.Scenarios object) on the worksheet.

The following code example uses the Scenarios method to add a new scenario to the current worksheet, and then displays the Scenario Manager dialog to verify that the scenario was added.

This example is for a document-level customization.

private void CreateScenario()
{   
    Excel.Range range1 = this.Range["A1", "B10"];
    range1.Formula = "=rand()";

    Excel.Scenarios scenarios1 =
        (Excel.Scenarios)this.Scenarios();

    Excel.Scenario newScenario = scenarios1.Add("New Scenario", 
        range1);

    // Show Scenario Manager dialog to verify that the scenario was added. 
    this.Application.Dialogs[Excel.XlBuiltInDialog.xlDialogScenarioCells].Show();
}

Show:
© 2014 Microsoft