ExcelScript.WorksheetFreezePanes interface

Package:

ExcelScript

Methods

freezeAt(frozenRange)	Sets the frozen cells in the active worksheet view. The range provided corresponds to cells that will be frozen in the top- and left-most pane.
freezeColumns(count)	Freeze the first column or columns of the worksheet in place.
freezeRows(count)	Freeze the top row or rows of the worksheet in place.
getLocation()	Gets a range that describes the frozen cells in the active worksheet view. The frozen range corresponds to cells that are frozen in the top- and left-most pane. If there is no frozen pane, then this method returns undefined.
unfreeze()	Removes all frozen panes in the worksheet.

Method Details

freezeAt(frozenRange)

Sets the frozen cells in the active worksheet view. The range provided corresponds to cells that will be frozen in the top- and left-most pane.

freezeAt(frozenRange: Range | string): void;

Parameters

frozenRange

ExcelScript.Range | string

A range that represents the cells to be frozen, or null to remove all frozen panes.

Returns

void

freezeColumns(count)

Freeze the first column or columns of the worksheet in place.

freezeColumns(count?: number): void;

Parameters

count

number

Optional number of columns to freeze, or zero to unfreeze all columns

Returns

void

freezeRows(count)

Freeze the top row or rows of the worksheet in place.

freezeRows(count?: number): void;

Parameters

count

number

Optional number of rows to freeze, or zero to unfreeze all rows

Returns

void

getLocation()

Gets a range that describes the frozen cells in the active worksheet view. The frozen range corresponds to cells that are frozen in the top- and left-most pane. If there is no frozen pane, then this method returns undefined.

getLocation(): Range;

Returns

ExcelScript.Range

unfreeze()

Removes all frozen panes in the worksheet.

unfreeze(): void;

Returns

void