aspose.cells

Class ScenarioCollection

Represents the list of scenarios.

Property Getters/Setters Summary
functiongetActiveIndex()
function
           Gets and sets which scenario is selected.
functiongetCount()
functiongetLastSelected()
function
           Indicates which scenario was last selected by the user to be run/shown.
functionget(index)
Gets the Scenario object by the index.
 
Method Summary
functionadd(value)
Reserved for internal use.
functionadd(name)
Adds a scenario.
functionclear()
functioncontains(value)
Reserved for internal use.
functionget(index)
Reserved for internal use.
functionindexOf(value)
Reserved for internal use.
functioniterator()
functionremoveAt(index)
 

    • Property Getters/Setters Detail

      • getActiveIndex/setActiveIndex : Number 

        function getActiveIndex() / function setActiveIndex(value)
        
        Gets and sets which scenario is selected.
      • getLastSelected/setLastSelected : Number 

        function getLastSelected() / function setLastSelected(value)
        
        Indicates which scenario was last selected by the user to be run/shown.
      • getCount : Number 

        function getCount()
        
      • get : Scenario 

        function get(index)
        
        Gets the Scenario object by the index.
        Parameters:
        index - The specific index in the list.
        Returns:
    • Method Detail

      • add

        function add(name)
        Adds a scenario.
        Parameters:
        name: String - The name of scenario.
        Returns:
        The index in the list of scenarios.
      • clear

        function clear()
      • removeAt

        function removeAt(index)
      • iterator

        function iterator()
      • get

        function get(index)
        Reserved for internal use.
      • contains

        function contains(value)
        Reserved for internal use.
      • add

        function add(value)
        Reserved for internal use.
      • indexOf

        function indexOf(value)
        Reserved for internal use.