Scenario

Scenario class

Represents an individual scenario.

class Scenario;

Properties

Property	Type	Description
comment	string	Gets and sets the comment of scenario.
name	string	Gets and sets the name of scenario.
user	string	Readonly. Gets name of user who last changed the scenario.
isHidden	boolean	Indicates whether scenario is hidden.
isLocked	boolean	Indicates whether scenario is locked for editing when the sheet is protected.
inputCells	ScenarioInputCellCollection	Readonly. Gets the input cells of scenario.

Methods

Method	Description
getComment()	@deprecated. Please use the ‘comment’ property instead. Gets and sets the comment of scenario.
setComment(string)	@deprecated. Please use the ‘comment’ property instead. Gets and sets the comment of scenario.
getName()	@deprecated. Please use the ’name’ property instead. Gets and sets the name of scenario.
setName(string)	@deprecated. Please use the ’name’ property instead. Gets and sets the name of scenario.
getUser()	@deprecated. Please use the ‘user’ property instead. Gets name of user who last changed the scenario.
isHidden()	@deprecated. Please use the ‘isHidden’ property instead. Indicates whether scenario is hidden.
setIsHidden(boolean)	@deprecated. Please use the ‘isHidden’ property instead. Indicates whether scenario is hidden.
isLocked()	@deprecated. Please use the ‘isLocked’ property instead. Indicates whether scenario is locked for editing when the sheet is protected.
setIsLocked(boolean)	@deprecated. Please use the ‘isLocked’ property instead. Indicates whether scenario is locked for editing when the sheet is protected.
getInputCells()	@deprecated. Please use the ‘inputCells’ property instead. Gets the input cells of scenario.
isNull()	Checks whether the implementation object is null.

comment

Gets and sets the comment of scenario.

comment : string;

name

Gets and sets the name of scenario.

name : string;

user

Readonly. Gets name of user who last changed the scenario.

user : string;

isHidden

Indicates whether scenario is hidden.

isHidden : boolean;

isLocked

Indicates whether scenario is locked for editing when the sheet is protected.

isLocked : boolean;

inputCells

Readonly. Gets the input cells of scenario.

inputCells : ScenarioInputCellCollection;

getComment()

@deprecated. Please use the ‘comment’ property instead. Gets and sets the comment of scenario.

getComment() : string;

setComment(string)

@deprecated. Please use the ‘comment’ property instead. Gets and sets the comment of scenario.

setComment(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getName()

@deprecated. Please use the ’name’ property instead. Gets and sets the name of scenario.

getName() : string;

setName(string)

@deprecated. Please use the ’name’ property instead. Gets and sets the name of scenario.

setName(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getUser()

@deprecated. Please use the ‘user’ property instead. Gets name of user who last changed the scenario.

getUser() : string;

isHidden()

@deprecated. Please use the ‘isHidden’ property instead. Indicates whether scenario is hidden.

isHidden() : boolean;

setIsHidden(boolean)

@deprecated. Please use the ‘isHidden’ property instead. Indicates whether scenario is hidden.

setIsHidden(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

isLocked()

@deprecated. Please use the ‘isLocked’ property instead. Indicates whether scenario is locked for editing when the sheet is protected.

isLocked() : boolean;

setIsLocked(boolean)

@deprecated. Please use the ‘isLocked’ property instead. Indicates whether scenario is locked for editing when the sheet is protected.

setIsLocked(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getInputCells()

@deprecated. Please use the ‘inputCells’ property instead. Gets the input cells of scenario.

getInputCells() : ScenarioInputCellCollection;

Returns

ScenarioInputCellCollection

isNull()

Checks whether the implementation object is null.

isNull() : boolean;