# GrapeCity.Documents.Excel.IScenario

## Content

<div class="doc-site-dotnet-api-container">



  <h1 id="GrapeCity_Documents_Excel_IScenario" data-uid="GrapeCity.Documents.Excel.IScenario" class="text-break">IScenario Interface
</h1>
  <div class="markdown level0 summary"><p>A scenario is a group of input values (called changing cells) that's named and saved.</p>
</div>
  <div class="markdown level0 conceptual"></div>
  <h6><strong>Namespace</strong>: <a class="xref" href="GrapeCity.Documents.Excel.html">GrapeCity.Documents.Excel</a></h6>
  <h6><strong>Assembly</strong>: DS.Documents.Excel.dll</h6>
  <h5 id="GrapeCity_Documents_Excel_IScenario_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public interface IScenario</code></pre>
  </div>
  <div class="codewrapper">
    <pre><code class="lang-vbnet hljs">Public Interface IScenario</code></pre>
  </div>
  <h3 id="properties">Properties
</h3>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td id="GrapeCity_Documents_Excel_IScenario_ChangingCells" data-uid="GrapeCity.Documents.Excel.IScenario.ChangingCells">
          <a class="xref" href="GrapeCity.Documents.Excel.IScenario.ChangingCells.html#GrapeCity_Documents_Excel_IScenario_ChangingCells">ChangingCells</a>
        </td>
        <td class="markdown level1 summary"><p>Returns a <a class="xref" href="GrapeCity.Documents.Excel.IRange.html">IRange</a> object that represents the changing cells for the scenario. Read-only.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Excel_IScenario_Comment" data-uid="GrapeCity.Documents.Excel.IScenario.Comment">
          <a class="xref" href="GrapeCity.Documents.Excel.IScenario.Comment.html#GrapeCity_Documents_Excel_IScenario_Comment">Comment</a>
        </td>
        <td class="markdown level1 summary"><p>Returns or sets a String value that represents the comment associated with the scenario.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Excel_IScenario_Hidden" data-uid="GrapeCity.Documents.Excel.IScenario.Hidden">
          <a class="xref" href="GrapeCity.Documents.Excel.IScenario.Hidden.html#GrapeCity_Documents_Excel_IScenario_Hidden">Hidden</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets a Boolean value that indicates if the scenario is hidden.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Excel_IScenario_Index" data-uid="GrapeCity.Documents.Excel.IScenario.Index">
          <a class="xref" href="GrapeCity.Documents.Excel.IScenario.Index.html#GrapeCity_Documents_Excel_IScenario_Index">Index</a>
        </td>
        <td class="markdown level1 summary"><p>Returns the index number of the object within the collection of similar objects.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Excel_IScenario_Locked" data-uid="GrapeCity.Documents.Excel.IScenario.Locked">
          <a class="xref" href="GrapeCity.Documents.Excel.IScenario.Locked.html#GrapeCity_Documents_Excel_IScenario_Locked">Locked</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets a Boolean value that indicates if the scenario is locked.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Excel_IScenario_Name" data-uid="GrapeCity.Documents.Excel.IScenario.Name">
          <a class="xref" href="GrapeCity.Documents.Excel.IScenario.Name.html#GrapeCity_Documents_Excel_IScenario_Name">Name</a>
        </td>
        <td class="markdown level1 summary"><p>Gets or sets a String value representing the name of the object.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Excel_IScenario_Values" data-uid="GrapeCity.Documents.Excel.IScenario.Values">
          <a class="xref" href="GrapeCity.Documents.Excel.IScenario.Values.html#GrapeCity_Documents_Excel_IScenario_Values">Values</a>
        </td>
        <td class="markdown level1 summary"><p>Returns a list that contains the current values of the changing cells for the scenario. Read-only.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="methods">Methods
</h3>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td id="GrapeCity_Documents_Excel_IScenario_ChangeScenario_GrapeCity_Documents_Excel_IRange_System_Collections_Generic_List_System_Object__" data-uid="GrapeCity.Documents.Excel.IScenario.ChangeScenario(GrapeCity.Documents.Excel.IRange,System.Collections.Generic.List{System.Object})">
          <a class="xref" href="GrapeCity.Documents.Excel.IScenario.ChangeScenario.html#GrapeCity_Documents_Excel_IScenario_ChangeScenario_GrapeCity_Documents_Excel_IRange_System_Collections_Generic_List_System_Object__">ChangeScenario(IRange, List&lt;object&gt;)</a>
        </td>
        <td class="markdown level1 summary"><p>Changes the scenario to have a new set of changing cells and (optionally) scenario values.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Excel_IScenario_Delete" data-uid="GrapeCity.Documents.Excel.IScenario.Delete">
          <a class="xref" href="GrapeCity.Documents.Excel.IScenario.Delete.html#GrapeCity_Documents_Excel_IScenario_Delete">Delete()</a>
        </td>
        <td class="markdown level1 summary"><p>Deletes the object.</p>
</td>
      </tr>
      <tr>
        <td id="GrapeCity_Documents_Excel_IScenario_Show" data-uid="GrapeCity.Documents.Excel.IScenario.Show">
          <a class="xref" href="GrapeCity.Documents.Excel.IScenario.Show.html#GrapeCity_Documents_Excel_IScenario_Show">Show()</a>
        </td>
        <td class="markdown level1 summary"><p>Shows the scenario by inserting its values on the worksheet. The affected cells are the changing cells of the scenario.</p>
</td>
      </tr>
    </tbody>
  </table>

</div>
