Edit

Share via

Excel.Interfaces.WindowCollectionLoadOptions interface

Package:
excel

Represents a collection of Window objects.

Remarks

[ API set: ExcelApiDesktop 1.1 ]

Properties

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
activeCell

For EACH ITEM in the collection: Specifies the active cell in the window.
activePane

For EACH ITEM in the collection: Specifies the active pane in the window.
activeWorksheet

For EACH ITEM in the collection: Specifies the active sheet in the window.
autoFilterDateGroupingEnabled

For EACH ITEM in the collection: Specifies whether AutoFilter date grouping is enabled in the window.
enableResize

For EACH ITEM in the collection: Specifies whether resizing is enabled for the window.
freezePanes

For EACH ITEM in the collection: Specifies whether panes are frozen in the window.
height

For EACH ITEM in the collection: Specifies the height of the window.
index

For EACH ITEM in the collection: Gets the index of the window.
isVisible

For EACH ITEM in the collection: Specifies whether the window is visible.
left

For EACH ITEM in the collection: Specifies the distance, in points, from the left edge of the computer screen to the left edge of the window.
name

For EACH ITEM in the collection: Specifies the name of the window.
rangeSelection

For EACH ITEM in the collection: Gets the range selection in the window.
scrollColumn

For EACH ITEM in the collection: Specifies the scroll column of the window.
scrollRow

For EACH ITEM in the collection: Specifies the scroll row of the window.
showFormulas

For EACH ITEM in the collection: Specifies whether formulas are shown in the window.
showGridlines

For EACH ITEM in the collection: Specifies whether gridlines are shown in the window.
showHeadings

For EACH ITEM in the collection: Specifies whether headings are shown in the window.
showHorizontalScrollBar

For EACH ITEM in the collection: Specifies whether the horizontal scroll bar is shown in the window.
showOutline

For EACH ITEM in the collection: Specifies whether outline is shown in the window.
showRightToLeft

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: Specifies whether the ruler is shown in the window.
showVerticalScrollBar

For EACH ITEM in the collection: Specifies whether the vertical scroll bar is shown in the window.
showWhitespace

For EACH ITEM in the collection: Specifies whether whitespace is shown in the window.
showWorkbookTabs

For EACH ITEM in the collection: Specifies whether workbook tabs are shown in the window.
showZeros

For EACH ITEM in the collection: Specifies whether zeroes are shown in the window.
split

For EACH ITEM in the collection: Specifies the split state of the window.
splitColumn

For EACH ITEM in the collection: Specifies the split column of the window.
splitHorizontal

For EACH ITEM in the collection: Specifies the horizontal split of the window.
splitRow

For EACH ITEM in the collection: Specifies the split row of the window.
splitVertical

For EACH ITEM in the collection: Specifies the vertical split of the window.
tabRatio

For EACH ITEM in the collection: Specifies the tab ratio of the window.
top

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: Specifies the type of the window.
usableHeight

For EACH ITEM in the collection: Specifies the usable height of the window.
usableWidth

For EACH ITEM in the collection: Specifies the usable width of the window.
view

For EACH ITEM in the collection: Specifies the view of the window.
visibleRange

For EACH ITEM in the collection: Gets the visible range of the window.
width

For EACH ITEM in the collection: Specifies the display width of the window.
windowNumber

For EACH ITEM in the collection: Specifies the window number.
windowState

For EACH ITEM in the collection: Specifies the window state.
zoom

For EACH ITEM in the collection: 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

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

activeCell

For EACH ITEM in the collection: Specifies the active cell in the window.

activeCell?: Excel.Interfaces.RangeLoadOptions;

Property Value

Excel.Interfaces.RangeLoadOptions

Remarks

[ API set: ExcelApiDesktop 1.1 ]

activePane

For EACH ITEM in the collection: Specifies the active pane in the window.

activePane?: Excel.Interfaces.PaneLoadOptions;

Property Value

Excel.Interfaces.PaneLoadOptions

Remarks

[ API set: ExcelApiDesktop 1.1 ]

activeWorksheet

For EACH ITEM in the collection: Specifies the active sheet in the window.

activeWorksheet?: Excel.Interfaces.WorksheetLoadOptions;

Property Value

Excel.Interfaces.WorksheetLoadOptions

Remarks

[ API set: ExcelApiDesktop 1.1 ]

autoFilterDateGroupingEnabled

For EACH ITEM in the collection: Specifies whether AutoFilter date grouping is enabled in the window.

autoFilterDateGroupingEnabled?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

enableResize

For EACH ITEM in the collection: Specifies whether resizing is enabled for the window.

enableResize?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

freezePanes

For EACH ITEM in the collection: Specifies whether panes are frozen in the window.

freezePanes?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

height

For EACH ITEM in the collection: Specifies the height of the window.

height?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

index

For EACH ITEM in the collection: Gets the index of the window.

index?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

isVisible

For EACH ITEM in the collection: Specifies whether the window is visible.

isVisible?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

left

For EACH ITEM in the collection: Specifies the distance, in points, from the left edge of the computer screen to the left edge of the window.

left?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

name

For EACH ITEM in the collection: Specifies the name of the window.

name?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

rangeSelection

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

For EACH ITEM in the collection: Gets the range selection in the window.

rangeSelection?: Excel.Interfaces.RangeAreasLoadOptions;

Property Value

Excel.Interfaces.RangeAreasLoadOptions

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

scrollColumn

For EACH ITEM in the collection: Specifies the scroll column of the window.

scrollColumn?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

scrollRow

For EACH ITEM in the collection: Specifies the scroll row of the window.

scrollRow?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

showFormulas

For EACH ITEM in the collection: Specifies whether formulas are shown in the window.

showFormulas?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

showGridlines

For EACH ITEM in the collection: Specifies whether gridlines are shown in the window.

showGridlines?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

showHeadings

For EACH ITEM in the collection: Specifies whether headings are shown in the window.

showHeadings?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

showHorizontalScrollBar

For EACH ITEM in the collection: Specifies whether the horizontal scroll bar is shown in the window.

showHorizontalScrollBar?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

showOutline

For EACH ITEM in the collection: Specifies whether outline is shown in the window.

showOutline?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

showRightToLeft

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: Specifies whether the ruler is shown in the window.

showRuler?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

showVerticalScrollBar

For EACH ITEM in the collection: Specifies whether the vertical scroll bar is shown in the window.

showVerticalScrollBar?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

showWhitespace

For EACH ITEM in the collection: Specifies whether whitespace is shown in the window.

showWhitespace?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

showWorkbookTabs

For EACH ITEM in the collection: Specifies whether workbook tabs are shown in the window.

showWorkbookTabs?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

showZeros

For EACH ITEM in the collection: Specifies whether zeroes are shown in the window.

showZeros?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

split

For EACH ITEM in the collection: Specifies the split state of the window.

split?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

splitColumn

For EACH ITEM in the collection: Specifies the split column of the window.

splitColumn?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

splitHorizontal

For EACH ITEM in the collection: Specifies the horizontal split of the window.

splitHorizontal?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

splitRow

For EACH ITEM in the collection: Specifies the split row of the window.

splitRow?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

splitVertical

For EACH ITEM in the collection: Specifies the vertical split of the window.

splitVertical?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

tabRatio

For EACH ITEM in the collection: Specifies the tab ratio of the window.

tabRatio?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

top

For EACH ITEM in the collection: 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?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

type

For EACH ITEM in the collection: Specifies the type of the window.

type?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

usableHeight

For EACH ITEM in the collection: Specifies the usable height of the window.

usableHeight?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

usableWidth

For EACH ITEM in the collection: Specifies the usable width of the window.

usableWidth?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

view

For EACH ITEM in the collection: Specifies the view of the window.

view?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

visibleRange

For EACH ITEM in the collection: Gets the visible range of the window.

visibleRange?: Excel.Interfaces.RangeLoadOptions;

Property Value

Excel.Interfaces.RangeLoadOptions

Remarks

[ API set: ExcelApiDesktop 1.1 ]

width

For EACH ITEM in the collection: Specifies the display width of the window.

width?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

windowNumber

For EACH ITEM in the collection: Specifies the window number.

windowNumber?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

windowState

For EACH ITEM in the collection: Specifies the window state.

windowState?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]

zoom

For EACH ITEM in the collection: Specifies an integer value that represents the display size of the window. It can be set to a percentage between 10 and 400.

zoom?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApiDesktop 1.1 ]