Excel.Window class

Specifies the active cell in the window.

readonly activeCell: Excel.Range;

Property Value

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Specifies the active pane in the window.

readonly activePane: Excel.Pane;

Property Value

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Specifies the active sheet in the window.

readonly activeWorksheet: Excel.Worksheet;

Property Value

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Specifies whether AutoFilter date grouping is enabled in the window.

autoFilterDateGroupingEnabled: boolean;

Property Value

Remarks

[ API set: ExcelApiDesktop 1.1 ]

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

Specifies whether resizing is enabled for the window.

readonly enableResize: boolean;

Property Value

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Specifies whether panes are frozen in the window.

freezePanes: boolean;

Property Value

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Specifies the height of the window.

height: number;

Property Value

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Gets the index of the window.

readonly index: number;

Property Value

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Specifies whether the window is visible.

isVisible: boolean;

Property Value

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Specifies the distance, in points, from the left edge of the computer screen to the left edge of the window.

left: number;

Property Value

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Specifies the name of the window.

name: string;

Property Value

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Gets a collection of panes associated with the window.

readonly panes: Excel.PaneCollection;

Property Value

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Gets the range selection in the window.

readonly rangeSelection: Excel.RangeAreas;

Property Value

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Specifies the scroll column of the window.

scrollColumn: number;

Property Value

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Specifies the scroll row of the window.

scrollRow: number;

Property Value

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Specifies whether formulas are shown in the window.

showFormulas: boolean;

Property Value

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Specifies whether gridlines are shown in the window.

showGridlines: boolean;

Property Value

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Specifies whether headings are shown in the window.

showHeadings: boolean;

Property Value

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Specifies whether the horizontal scroll bar is shown in the window.

showHorizontalScrollBar: boolean;

Property Value

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Specifies whether outline is shown in the window.

showOutline: boolean;

Property Value

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Gets the right-to-left layout value of the window. True means that the window is using right-to-left layout, false means that the window is using left-to-right layout.

readonly showRightToLeft: boolean;

Property Value

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Specifies whether the ruler is shown in the window.

showRuler: boolean;

Property Value

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Specifies whether the vertical scroll bar is shown in the window.

showVerticalScrollBar: boolean;

Property Value

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Specifies whether whitespace is shown in the window.

showWhitespace: boolean;

Property Value

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Specifies whether workbook tabs are shown in the window.

showWorkbookTabs: boolean;

Property Value

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Specifies whether zeroes are shown in the window.

showZeros: boolean;

Property Value

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Specifies the split state of the window.

split: boolean;

Property Value

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Specifies the split column of the window.

splitColumn: number;

Property Value

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Specifies the horizontal split of the window.

splitHorizontal: number;

Property Value

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Specifies the split row of the window.

splitRow: number;

Property Value

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Specifies the vertical split of the window.

splitVertical: number;

Property Value

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Specifies the tab ratio of the window.

tabRatio: number;

Property Value

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Specifies the distance, in points, from the top edge of the window to the top edge of the usable area (below the menus, any toolbars docked at the top, and the formula bar).

top: number;

Property Value

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Specifies the type of the window.

readonly type: Excel.WindowType | "chartAsWindow" | "chartInPlace" | "clipboard" | "workbook";

Property Value

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Specifies the usable height of the window.

readonly usableHeight: number;

Property Value

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Specifies the usable width of the window.

readonly usableWidth: number;

Property Value

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Specifies the view of the window.

view: Excel.WindowView | "normalView" | "pageBreakPreview" | "pageLayoutView";

Property Value

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Gets the visible range of the window.

readonly visibleRange: Excel.Range;

Property Value

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Specifies the display width of the window.

width: number;

Property Value

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Gets the window number.

readonly windowNumber: number;

Property Value

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Specifies the window state.

windowState: Excel.WindowState | "maximized" | "minimized" | "normal";

Property Value

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Specifies an integer value that represents the display size of the window. It can be set to a percentage between 10 and 400.

zoom: number;

Property Value

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Activates the window.

activate(): void;

Returns

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Activates the next window.

activateNext(): void;

Returns

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Activates the previous window.

activatePrevious(): void;

Returns

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Closes the window.

close(): OfficeExtension.ClientResult<boolean>;

Returns

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Scrolls the window by multiple pages. The down, up, toRight, and toLeft parameters correspond to the action of scrolling with Page Down, Page Up, Alt+Page Down, and Alt+Page Up keys on the keyboard.

largeScroll(Down: number, Up: number, ToRight: number, ToLeft: number): void;

Parameters

Returns

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(options?: Excel.Interfaces.WindowLoadOptions): Excel.Window;

Parameters

Returns

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNames?: string | string[]): Excel.Window;

Parameters

Returns

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.Window;

Parameters

Returns

Opens a new Excel window.

newWindow(): Excel.Window;

Returns

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Converts horizontal points to screen pixels.

pointsToScreenPixelsX(Points: number): OfficeExtension.ClientResult<number>;

Parameters

Returns

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Converts vertical points to screen pixels.

pointsToScreenPixelsY(Points: number): OfficeExtension.ClientResult<number>;

Parameters

Returns

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Scrolls the window to bring the specified range into view.

scrollIntoView(Left: number, Top: number, Width: number, Height: number, Start?: boolean): void;

Parameters

Returns

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Scrolls the workbook tabs.

scrollWorkbookTabs(Sheets?: number, Position?: Excel.ScrollWorkbookTabPosition): void;

Parameters

Returns

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Scrolls the workbook tabs.

scrollWorkbookTabs(Sheets?: number, Position?: "First" | "Last"): void;

Parameters

Returns

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties: Interfaces.WindowUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameters

Returns

Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Excel.Window): void;

Parameters

Returns

Scrolls the window by a number of rows or columns. The down, up, toRight, and toLeft parameters correspond to the action of scrolling with arrow keys on the keyboard.

smallScroll(Down: number, Up: number, ToRight: number, ToLeft: number): void;

Parameters

Returns

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original Excel.Window object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.WindowData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.WindowData;

Returns