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)
Syntax
'Declaration
Public Function Scenarios ( _
index As Object _
) As Object
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.
Examples
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 Sub CreateScenario()
Dim range1 As Excel.Range = Me.Range("A1", "B10")
range1.Formula = "=rand()"
Dim scenarios1 As Excel.Scenarios = _
CType(Me.Scenarios(), Excel.Scenarios)
Dim newScenario As Excel.Scenario = _
scenarios1.Add("New Scenario", range1)
' Show Scenario Manager dialog to verify that the scenario was added.
Me.Application.Dialogs(Excel.XlBuiltInDialog.xlDialogScenarioCells).Show()
End Sub
private void CreateScenario()
{
Excel.Range range1 = this.Range["A1", "B10"];
range1.Formula = "=rand()";
Excel.Scenarios scenarios1 =
(Excel.Scenarios)this.Scenarios(missing);
Excel.Scenario newScenario = scenarios1.Add("New Scenario",
range1, missing, missing, missing, missing);
// Show Scenario Manager dialog to verify that the scenario was added.
this.Application.Dialogs[Excel.XlBuiltInDialog.xlDialogScenarioCells].Show(
missing, missing, missing, missing, missing, missing, missing, missing,
missing, missing, missing, missing, missing, missing, missing, missing,
missing, missing, missing, missing, missing, missing, missing, missing,
missing, missing, missing, missing, missing, missing);
}
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.