Word.Interfaces.WindowData interface
An interface describing the data returned by calling window.toJSON().
Properties
| are |
Specifies whether rulers are displayed for the window or pane. |
| are |
Specifies whether comments, footnotes, endnotes, and hyperlinks are displayed as tips. |
| are |
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). |
| horizontal |
Specifies the horizontal scroll position as a percentage of the document width. |
| ime |
Specifies the default start-up mode for the Japanese Input Method Editor (IME). |
| index | Gets the position of an item in a collection. |
| is |
Specifies whether the window is active. |
| is |
Specifies whether the document map is visible. |
| is |
Specifies whether the email message header is visible in the document window. The default value is |
| is |
Specifies whether a horizontal scroll bar is displayed for the window. |
| is |
Specifies whether the vertical scroll bar appears on the left side of the document window. |
| is |
Specifies whether the vertical ruler appears on the right side of the document window in print layout view. |
| is |
Specifies whether the window is split into multiple panes. |
| is |
Specifies whether a vertical ruler is displayed for the window or pane. |
| is |
Specifies whether a vertical scroll bar is displayed for the window. |
| is |
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. |
| show |
Specifies how Microsoft Word displays source documents after a compare and merge process. |
| split |
Specifies the vertical split percentage for the window. |
| state | Specifies the state of the document window or task window. |
| style |
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. |
| usable |
Gets the height (in points) of the active working area in the document window. |
| usable |
Gets the width (in points) of the active working area in the document window. |
| vertical |
Specifies the vertical scroll position as a percentage of the document length. |
| width | Specifies the width of the document window, in points. |
| window |
Gets an integer that represents the position of the window. |
Property Details
areRulersDisplayed
Specifies whether rulers are displayed for the window or pane.
areRulersDisplayed?: boolean;Property Value
boolean
Remarks
areScreenTipsDisplayed
Specifies whether comments, footnotes, endnotes, and hyperlinks are displayed as tips.
areScreenTipsDisplayed?: boolean;Property Value
boolean
Remarks
areThumbnailsDisplayed
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
caption
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
height
Specifies the height of the window (in points).
height?: number;Property Value
number
Remarks
horizontalPercentScrolled
Specifies the horizontal scroll position as a percentage of the document width.
horizontalPercentScrolled?: number;Property Value
number
Remarks
imeMode
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
index
Gets the position of an item in a collection.
index?: number;Property Value
number
Remarks
isActive
Specifies whether the window is active.
isActive?: boolean;Property Value
boolean
Remarks
isDocumentMapVisible
Specifies whether the document map is visible.
isDocumentMapVisible?: boolean;Property Value
boolean
Remarks
isEnvelopeVisible
Specifies whether the email message header is visible in the document window. The default value is false.
isEnvelopeVisible?: boolean;Property Value
boolean
Remarks
isHorizontalScrollBarDisplayed
Specifies whether a horizontal scroll bar is displayed for the window.
isHorizontalScrollBarDisplayed?: boolean;Property Value
boolean
Remarks
isLeftScrollBarDisplayed
Specifies whether the vertical scroll bar appears on the left side of the document window.
isLeftScrollBarDisplayed?: boolean;Property Value
boolean
Remarks
isRightRulerDisplayed
Specifies whether the vertical ruler appears on the right side of the document window in print layout view.
isRightRulerDisplayed?: boolean;Property Value
boolean
Remarks
isSplit
Specifies whether the window is split into multiple panes.
isSplit?: boolean;Property Value
boolean
Remarks
isVerticalRulerDisplayed
Specifies whether a vertical ruler is displayed for the window or pane.
isVerticalRulerDisplayed?: boolean;Property Value
boolean
Remarks
isVerticalScrollBarDisplayed
Specifies whether a vertical scroll bar is displayed for the window.
isVerticalScrollBarDisplayed?: boolean;Property Value
boolean
Remarks
isVisible
Specifies whether the window is visible.
isVisible?: boolean;Property Value
boolean
Remarks
left
Specifies the horizontal position of the window, measured in points.
left?: number;Property Value
number
Remarks
next
Gets the next document window in the collection of open document windows.
next?: Word.Interfaces.WindowData;Property Value
Remarks
previous
Gets the previous document window in the collection open document windows.
previous?: Word.Interfaces.WindowData;Property Value
Remarks
showSourceDocuments
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
splitVertical
Specifies the vertical split percentage for the window.
splitVertical?: number;Property Value
number
Remarks
state
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.
state?: Word.WindowState | "Normal" | "Maximize" | "Minimize";Property Value
Word.WindowState | "Normal" | "Maximize" | "Minimize"
Remarks
styleAreaWidth
Specifies the width of the style area in points.
styleAreaWidth?: number;Property Value
number
Remarks
top
Specifies the vertical position of the document window, in points.
top?: number;Property Value
number
Remarks
type
Gets the window type.
type?: Word.WindowType | "Document" | "Template";Property Value
Word.WindowType | "Document" | "Template"
Remarks
usableHeight
Gets the height (in points) of the active working area in the document window.
usableHeight?: number;Property Value
number
Remarks
usableWidth
Gets the width (in points) of the active working area in the document window.
usableWidth?: number;Property Value
number
Remarks
verticalPercentScrolled
Specifies the vertical scroll position as a percentage of the document length.
verticalPercentScrolled?: number;Property Value
number
Remarks
width
Specifies the width of the document window, in points.
width?: number;Property Value
number
Remarks
windowNumber
Gets an integer that represents the position of the window.
windowNumber?: number;Property Value
number