ExcelScript.NamedSheetView interface

Package:

ExcelScript

Represents a named sheet view of a worksheet. A sheet view stores the sort and filter rules for a particular worksheet. Every sheet view (even a temporary sheet view) has a unique, worksheet-scoped name that is used to access the view.

Methods

activate()	Activates this sheet view. This is equivalent to using "Switch To" in the Excel UI.
delete()	Removes the sheet view from the worksheet.
duplicate(name)	Creates a copy of this sheet view.
getName()	Gets or sets the name of the sheet view. The temporary sheet view name is the empty string (""). Naming the view by using the name property causes the sheet view to be saved.
setName(name)	Gets or sets the name of the sheet view. The temporary sheet view name is the empty string (""). Naming the view by using the name property causes the sheet view to be saved.

Method Details

activate()

Activates this sheet view. This is equivalent to using "Switch To" in the Excel UI.

activate(): void;

Returns

void

delete()

Removes the sheet view from the worksheet.

delete(): void;

Returns

void

duplicate(name)

Creates a copy of this sheet view.

duplicate(name?: string): NamedSheetView;

Parameters

name

string

The name of the duplicated sheet view. If no name is provided, one will be generated.

Returns

ExcelScript.NamedSheetView

getName()

Gets or sets the name of the sheet view. The temporary sheet view name is the empty string (""). Naming the view by using the name property causes the sheet view to be saved.

getName(): string;

Returns

string

setName(name)

Gets or sets the name of the sheet view. The temporary sheet view name is the empty string (""). Naming the view by using the name property causes the sheet view to be saved.

setName(name: string): void;

Parameters

name

string

Returns

void