Edit

Share via

Excel.Interfaces.WindowData interface

Package:
excel

An interface describing the data returned by calling window.toJSON().

Properties

activeCell

Gets the active cell in the window.
activePane

Gets the active pane in the window.
activeWorksheet

Gets the active worksheet in the window.
autoFilterDateGroupingEnabled

Specifies whether AutoFilter date grouping is enabled in the window.
enableResize

Specifies whether resizing is enabled for the window.
freezePanes

Specifies whether panes are frozen in the window.
height

Specifies the height of the window.
index

Gets the index of the window.
isVisible

Specifies whether the window is visible.
left

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

Specifies the name of the window.
panes

Gets a collection of panes associated with the window.
scrollColumn

Specifies the scroll column of the window.
scrollRow

Specifies the scroll row of the window.
showFormulas

Specifies whether formulas are shown in the window.
showGridlines

Specifies whether gridlines are shown in the window.
showHeadings

Specifies whether headings are shown in the window.
showHorizontalScrollBar

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

Specifies whether outline is shown in the window.
showRightToLeft

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.
showRuler

Specifies whether the ruler is shown in the window.
showVerticalScrollBar

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

Specifies whether whitespace is shown in the window.
showWorkbookTabs

Specifies whether workbook tabs are shown in the window.
showZeros

Specifies whether zeroes are shown in the window.
split

Specifies the split state of the window.
splitColumn

Specifies the split column of the window.
splitHorizontal

Specifies the horizontal split of the window.
splitRow

Specifies the split row of the window.
splitVertical

Specifies the vertical split of the window.
tabRatio

Specifies the tab ratio of the window.
top

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).
type

Specifies the type of the window.
usableHeight

Gets the usable height of the window.
usableWidth

Gets the usable width of the window.
view

Specifies the view of the window.
visibleRange

Gets the visible range of the window.
width

Specifies the display width of the window.
windowNumber

Gets the window number.
windowState

Specifies the window state.
zoom

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

Property Details

activeCell

Gets the active cell in the window.

activeCell?: Excel.Interfaces.RangeData;

Property Value

Excel.Interfaces.RangeData

Remarks

[ API set: ExcelApiDesktop 1.1 ]

activePane

Gets the active pane in the window.

activePane?: Excel.Interfaces.PaneData;

Property Value

Excel.Interfaces.PaneData

Remarks

[ API set: ExcelApiDesktop 1.1 ]

activeWorksheet

Gets the active worksheet in the window.

activeWorksheet?: Excel.Interfaces.WorksheetData;

Property Value

Excel.Interfaces.WorksheetData

Remarks

[ API set: ExcelApiDesktop 1.1 ]

autoFilterDateGroupingEnabled

Specifies whether AutoFilter date grouping is enabled in the window.

autoFilterDateGroupingEnabled?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

enableResize

Specifies whether resizing is enabled for the window.

enableResize?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

freezePanes

Specifies whether panes are frozen in the window.

freezePanes?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

height

Specifies the height of the window.

height?: number;

Property Value

number

Remarks

[ API set: ExcelApiDesktop 1.1 ]

index

Gets the index of the window.

index?: number;

Property Value

number

Remarks

[ API set: ExcelApiDesktop 1.1 ]

isVisible

Specifies whether the window is visible.

isVisible?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

left

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

left?: number;

Property Value

number

Remarks

[ API set: ExcelApiDesktop 1.1 ]

name

Specifies the name of the window.

name?: string;

Property Value

string

Remarks

[ API set: ExcelApiDesktop 1.1 ]

panes

Gets a collection of panes associated with the window.

panes?: Excel.Interfaces.PaneData[];

Property Value

Excel.Interfaces.PaneData[]

Remarks

[ API set: ExcelApiDesktop 1.1 ]

scrollColumn

Specifies the scroll column of the window.

scrollColumn?: number;

Property Value

number

Remarks

[ API set: ExcelApiDesktop 1.1 ]

scrollRow

Specifies the scroll row of the window.

scrollRow?: number;

Property Value

number

Remarks

[ API set: ExcelApiDesktop 1.1 ]

showFormulas

Specifies whether formulas are shown in the window.

showFormulas?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

showGridlines

Specifies whether gridlines are shown in the window.

showGridlines?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

showHeadings

Specifies whether headings are shown in the window.

showHeadings?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

showHorizontalScrollBar

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

showHorizontalScrollBar?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

showOutline

Specifies whether outline is shown in the window.

showOutline?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

showRightToLeft

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.

showRightToLeft?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

showRuler

Specifies whether the ruler is shown in the window.

showRuler?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

showVerticalScrollBar

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

showVerticalScrollBar?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

showWhitespace

Specifies whether whitespace is shown in the window.

showWhitespace?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

showWorkbookTabs

Specifies whether workbook tabs are shown in the window.

showWorkbookTabs?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

showZeros

Specifies whether zeroes are shown in the window.

showZeros?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

split

Specifies the split state of the window.

split?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

splitColumn

Specifies the split column of the window.

splitColumn?: number;

Property Value

number

Remarks

[ API set: ExcelApiDesktop 1.1 ]

splitHorizontal

Specifies the horizontal split of the window.

splitHorizontal?: number;

Property Value

number

Remarks

[ API set: ExcelApiDesktop 1.1 ]

splitRow

Specifies the split row of the window.

splitRow?: number;

Property Value

number

Remarks

[ API set: ExcelApiDesktop 1.1 ]

splitVertical

Specifies the vertical split of the window.

splitVertical?: number;

Property Value

number

Remarks

[ API set: ExcelApiDesktop 1.1 ]

tabRatio

Specifies the tab ratio of the window.

tabRatio?: number;

Property Value

number

Remarks

[ API set: ExcelApiDesktop 1.1 ]

top

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

number

Remarks

[ API set: ExcelApiDesktop 1.1 ]

type

Specifies the type of the window.

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

Property Value

Excel.WindowType | "chartAsWindow" | "chartInPlace" | "clipboard" | "workbook"

Remarks

[ API set: ExcelApiDesktop 1.1 ]

usableHeight

Gets the usable height of the window.

usableHeight?: number;

Property Value

number

Remarks

[ API set: ExcelApiDesktop 1.1 ]

usableWidth

Gets the usable width of the window.

usableWidth?: number;

Property Value

number

Remarks

[ API set: ExcelApiDesktop 1.1 ]

view

Specifies the view of the window.

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

Property Value

Excel.WindowView | "normalView" | "pageBreakPreview" | "pageLayoutView"

Remarks

[ API set: ExcelApiDesktop 1.1 ]

visibleRange

Gets the visible range of the window.

visibleRange?: Excel.Interfaces.RangeData;

Property Value

Excel.Interfaces.RangeData

Remarks

[ API set: ExcelApiDesktop 1.1 ]

width

Specifies the display width of the window.

width?: number;

Property Value

number

Remarks

[ API set: ExcelApiDesktop 1.1 ]

windowNumber

Gets the window number.

windowNumber?: number;

Property Value

number

Remarks

[ API set: ExcelApiDesktop 1.1 ]

windowState

Specifies the window state.

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

Property Value

Excel.WindowState | "maximized" | "minimized" | "normal"

Remarks

[ API set: ExcelApiDesktop 1.1 ]

zoom

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

number

Remarks

[ API set: ExcelApiDesktop 1.1 ]