Edit

Share via

Word.Interfaces.WindowData interface

Package:
word

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

Properties

areRulersDisplayed

Specifies whether rulers are displayed for the window or pane.
areScreenTipsDisplayed

Specifies whether comments, footnotes, endnotes, and hyperlinks are displayed as tips.
areThumbnailsDisplayed

Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window.
caption

Specifies the caption text for the window that is displayed in the title bar of the document or application window.
height

Specifies the height of the window (in points).
horizontalPercentScrolled

Specifies the horizontal scroll position as a percentage of the document width.
imeMode

Specifies the default start-up mode for the Japanese Input Method Editor (IME).
index

Gets the position of an item in a collection.
isActive

Specifies whether the window is active.
isDocumentMapVisible

Specifies whether the document map is visible.
isEnvelopeVisible

Specifies whether the email message header is visible in the document window. The default value is False.
isHorizontalScrollBarDisplayed

Specifies whether a horizontal scroll bar is displayed for the window.
isLeftScrollBarDisplayed

Specifies whether the vertical scroll bar appears on the left side of the document window.
isRightRulerDisplayed

Specifies whether the vertical ruler appears on the right side of the document window in print layout view.
isSplit

Specifies whether the window is split into multiple panes.
isVerticalRulerDisplayed

Specifies whether a vertical ruler is displayed for the window or pane.
isVerticalScrollBarDisplayed

Specifies whether a vertical scroll bar is displayed for the window.
isVisible

Specifies whether the window is visible.
left

Specifies the horizontal position of the window, measured in points.
next

Gets the next document window in the collection of open document windows.
previous

Gets the previous document window in the collection open document windows.
showSourceDocuments

Specifies how Microsoft Word displays source documents after a compare and merge process.
splitVertical

Specifies the vertical split percentage for the window.
styleAreaWidth

Specifies the width of the style area in points.
top

Specifies the vertical position of the document window, in points.
type

Gets the window type.
usableHeight

Gets the height (in points) of the active working area in the document window.
usableWidth

Gets the width (in points) of the active working area in the document window.
verticalPercentScrolled

Specifies the vertical scroll position as a percentage of the document length.
width

Specifies the width of the document window, in points.
windowNumber

Gets an integer that represents the position of the window.
windowState

Specifies the state of the document window or task window.

Property Details

areRulersDisplayed

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.

Specifies whether rulers are displayed for the window or pane.

areRulersDisplayed?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

areScreenTipsDisplayed

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.

Specifies whether comments, footnotes, endnotes, and hyperlinks are displayed as tips.

areScreenTipsDisplayed?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

areThumbnailsDisplayed

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.

Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window.

areThumbnailsDisplayed?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

caption

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.

Specifies the caption text for the window that is displayed in the title bar of the document or application window.

caption?: string;

Property Value

string

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

height

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.

Specifies the height of the window (in points).

height?: number;

Property Value

number

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

horizontalPercentScrolled

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.

Specifies the horizontal scroll position as a percentage of the document width.

horizontalPercentScrolled?: number;

Property Value

number

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

imeMode

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.

Specifies the default start-up mode for the Japanese Input Method Editor (IME).

imeMode?: Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul";

Property Value

Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul"

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

index

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.

Gets the position of an item in a collection.

index?: number;

Property Value

number

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

isActive

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.

Specifies whether the window is active.

isActive?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

isDocumentMapVisible

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.

Specifies whether the document map is visible.

isDocumentMapVisible?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

isEnvelopeVisible

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.

Specifies whether the email message header is visible in the document window. The default value is False.

isEnvelopeVisible?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

isHorizontalScrollBarDisplayed

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.

Specifies whether a horizontal scroll bar is displayed for the window.

isHorizontalScrollBarDisplayed?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

isLeftScrollBarDisplayed

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.

Specifies whether the vertical scroll bar appears on the left side of the document window.

isLeftScrollBarDisplayed?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

isRightRulerDisplayed

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.

Specifies whether the vertical ruler appears on the right side of the document window in print layout view.

isRightRulerDisplayed?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

isSplit

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.

Specifies whether the window is split into multiple panes.

isSplit?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

isVerticalRulerDisplayed

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.

Specifies whether a vertical ruler is displayed for the window or pane.

isVerticalRulerDisplayed?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

isVerticalScrollBarDisplayed

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.

Specifies whether a vertical scroll bar is displayed for the window.

isVerticalScrollBarDisplayed?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

isVisible

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.

Specifies whether the window is visible.

isVisible?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

left

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.

Specifies the horizontal position of the window, measured in points.

left?: number;

Property Value

number

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

next

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.

Gets the next document window in the collection of open document windows.

next?: Word.Interfaces.WindowData;

Property Value

Word.Interfaces.WindowData

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

previous

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.

Gets the previous document window in the collection open document windows.

previous?: Word.Interfaces.WindowData;

Property Value

Word.Interfaces.WindowData

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

showSourceDocuments

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.

Specifies how Microsoft Word displays source documents after a compare and merge process.

showSourceDocuments?: Word.ShowSourceDocuments | "None" | "Original" | "Revised" | "Both";

Property Value

Word.ShowSourceDocuments | "None" | "Original" | "Revised" | "Both"

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

splitVertical

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.

Specifies the vertical split percentage for the window.

splitVertical?: number;

Property Value

number

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

styleAreaWidth

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.

Specifies the width of the style area in points.

styleAreaWidth?: number;

Property Value

number

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

top

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.

Specifies the vertical position of the document window, in points.

top?: number;

Property Value

number

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

type

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.

Gets the window type.

type?: Word.WindowType | "Document" | "Template";

Property Value

Word.WindowType | "Document" | "Template"

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

usableHeight

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.

Gets the height (in points) of the active working area in the document window.

usableHeight?: number;

Property Value

number

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

usableWidth

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.

Gets the width (in points) of the active working area in the document window.

usableWidth?: number;

Property Value

number

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

verticalPercentScrolled

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.

Specifies the vertical scroll position as a percentage of the document length.

verticalPercentScrolled?: number;

Property Value

number

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

width

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.

Specifies the width of the document window, in points.

width?: number;

Property Value

number

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

windowNumber

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.

Gets an integer that represents the position of the window.

windowNumber?: number;

Property Value

number

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

windowState

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.

Specifies the state of the document window or task window.

windowState?: Word.WindowState | "Normal" | "Maximize" | "Minimize";

Property Value

Word.WindowState | "Normal" | "Maximize" | "Minimize"

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]