Scenario
Contents
[
Hide
]Scenario class
Represents an individual scenario.
class Scenario;
Methods
| Method | Description |
|---|---|
| getComment() | Gets and sets the comment of scenario. |
| setComment(string) | Gets and sets the comment of scenario. |
| getName() | Gets and sets the name of scenario. |
| setName(string) | Gets and sets the name of scenario. |
| getUser() | Gets name of user who last changed the scenario. |
| isHidden() | Indicates whether scenario is hidden. |
| setIsHidden(boolean) | Indicates whether scenario is hidden. |
| isLocked() | Indicates whether scenario is locked for editing when the sheet is protected. |
| setIsLocked(boolean) | Indicates whether scenario is locked for editing when the sheet is protected. |
| getInputCells() | Gets the input cells of scenario. |
| isNull() | Checks whether the implementation object is null. |
getComment()
Gets and sets the comment of scenario.
getComment() : string;
setComment(string)
Gets and sets the comment of scenario.
setComment(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getName()
Gets and sets the name of scenario.
getName() : string;
setName(string)
Gets and sets the name of scenario.
setName(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getUser()
Gets name of user who last changed the scenario.
getUser() : string;
isHidden()
Indicates whether scenario is hidden.
isHidden() : boolean;
setIsHidden(boolean)
Indicates whether scenario is hidden.
setIsHidden(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
isLocked()
Indicates whether scenario is locked for editing when the sheet is protected.
isLocked() : boolean;
setIsLocked(boolean)
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()
Gets the input cells of scenario.
getInputCells() : ScenarioInputCellCollection;
Returns
isNull()
Checks whether the implementation object is null.
isNull() : boolean;