ScenarioCollection

Inheritance: java.lang.Object, com.aspose.cells.CollectionBase

public class ScenarioCollection extends CollectionBase

Represents the list of scenarios.

Methods

MethodDescription
add(Object o)Adds an item to the CollectionBase instance.
add(String name)Adds a scenario.
clear()Removes all objects from the CollectionBase instance.
contains(Object o)Return whether instance contains this object
equals(Object arg0)
get(int index)Gets the Scenario object by the index.
getActiveIndex()Gets which scenario is selected.
getClass()
getCount()Gets the number of elements contained in the CollectionBase instance.
getLastSelected()Indicates which scenario was last selected by the user to be run/shown.
hashCode()
indexOf(Object o)Determines the index of a specific item in the CollectionBase instance.
iterator()Returns an enumerator that iterates through the CollectionBase instance.
notify()
notifyAll()
removeAt(int index)Removes the item at the specified index.
setActiveIndex(int value)Sets which scenario is selected.
setLastSelected(int value)Indicates which scenario was last selected by the user to be run/shown.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

add(Object o)

public int add(Object o)

Adds an item to the CollectionBase instance.

Parameters:

ParameterTypeDescription
ojava.lang.ObjectThe Object to add to the CollectionBase instance.

Returns: int - The position into which the new element was inserted.

add(String name)

public int add(String name)

Adds a scenario.

Parameters:

ParameterTypeDescription
namejava.lang.StringThe name of scenario.

Returns: int - The index in the list of scenarios.

clear()

public void clear()

Removes all objects from the CollectionBase instance.

contains(Object o)

public boolean contains(Object o)

Return whether instance contains this object

Parameters:

ParameterTypeDescription
ojava.lang.Objecttest object

Returns: boolean - Whether instance contains this object

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

ParameterTypeDescription
arg0java.lang.Object

Returns: boolean

get(int index)

public Scenario get(int index)

Gets the Scenario object by the index.

Parameters:

ParameterTypeDescription
indexintThe specific index in the list.

Returns: Scenario -

getActiveIndex()

public int getActiveIndex()

Gets which scenario is selected.

Returns: int

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getCount()

public int getCount()

Gets the number of elements contained in the CollectionBase instance.

Returns: int - The number of elements contained in the CollectionBase instance.

getLastSelected()

public int getLastSelected()

Indicates which scenario was last selected by the user to be run/shown.

Returns: int

hashCode()

public native int hashCode()

Returns: int

indexOf(Object o)

public int indexOf(Object o)

Determines the index of a specific item in the CollectionBase instance.

Parameters:

ParameterTypeDescription
ojava.lang.ObjectDetermines the index of a specific item in the CollectionBase instance.

Returns: int - The index of value if found in the list; otherwise, -1.

iterator()

public Iterator iterator()

Returns an enumerator that iterates through the CollectionBase instance.

Returns: java.util.Iterator - An iterator for the CollectionBase instance.

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

removeAt(int index)

public void removeAt(int index)

Removes the item at the specified index.

Parameters:

ParameterTypeDescription
indexintThe zero-based index of the item to remove.

setActiveIndex(int value)

public void setActiveIndex(int value)

Sets which scenario is selected.

Parameters:

ParameterTypeDescription
valueint

setLastSelected(int value)

public void setLastSelected(int value)

Indicates which scenario was last selected by the user to be run/shown.

Parameters:

ParameterTypeDescription
valueint

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

ParameterTypeDescription
arg0long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

ParameterTypeDescription
arg0long
arg1int