Word.Interfaces.ViewData interface
An interface describing the data returned by calling view.toJSON().
Properties
| are |
Specifies whether all nonprinting characters are displayed. |
| are |
Gets whether background colors and images are shown when the document is displayed in print layout view. |
| are |
Gets whether square brackets are displayed at the beginning and end of each bookmark. |
| are |
Specifies whether Microsoft Word displays the comments in the document. |
| are |
Specifies whether Microsoft Word displays connecting lines from the text to the revision and comment balloons. |
| are |
Gets whether crop marks are shown in the corners of pages to indicate where margins are located. |
| are |
Gets whether objects created with the drawing tools are displayed in print layout view. |
| are |
Specifies whether shading is applied to the ranges in the document that users have permission to modify. |
| are |
Specifies whether field codes are displayed. |
| are |
Specifies whether Microsoft Word displays formatting changes made to the document with Track Changes enabled. |
| are |
Specifies whether handwritten ink annotations are shown or hidden. |
| are |
Specifies whether Microsoft Word displays insertions and deletions made to the document with Track Changes enabled. |
| are |
Gets whether lines wrap at the right edge of the document window rather than at the right margin or the right column boundary. |
| are |
Gets whether object anchors are displayed next to items that can be positioned in print layout view. |
| are |
Gets whether Microsoft Word displays optional line breaks. |
| are |
Gets whether optional hyphens are displayed. |
| are |
Gets whether other authors' presence should be visible in the document. |
| are |
Gets whether the top and bottom margins and the gray area between pages in the document are displayed. |
| are |
Gets whether paragraph marks are displayed. |
| are |
Gets whether blank boxes are displayed as placeholders for pictures. |
| are |
Specifies whether Microsoft Word displays revisions and comments made to the document with Track Changes enabled. |
| are |
Gets whether space characters are displayed. |
| are |
Specifies whether table gridlines are displayed. |
| are |
Gets whether tab characters are displayed. |
| are |
Gets whether dotted lines are displayed around page margins, text columns, objects, and frames in print layout view. |
| column |
Specifies the column width in Reading mode. |
| field |
Gets on-screen shading for fields. |
| is |
Specifies whether all the text in a window is displayed in the same sans-serif font with minimal formatting to speed up display. |
| is |
Specifies whether only the first line of body text is shown in outline view. |
| is |
Specifies whether character formatting is visible in outline view. |
| is |
Specifies whether the window is in full-screen view. |
| is |
Gets whether text formatted as hidden text is displayed. |
| is |
Gets whether highlight formatting is displayed and printed with the document. |
| is |
Specifies whether the document is in conflict mode view. |
| is |
Specifies whether Microsoft Word is in Panning mode. |
| is |
Specifies whether the document is being viewed in reading layout view. |
| is |
Specifies whether mail merge data is displayed instead of mail merge fields. |
| is |
Specifies whether the text in the document is visible when the header and footer areas are displayed. |
| is |
Specifies whether the pointer is displayed as a magnifying glass in print preview. |
| is |
Specifies whether pages displayed in reading layout view are displayed using the same layout as printed pages. |
| is |
Specifies whether XML tags are visible in the document. |
| markup |
Specifies the display mode for tracked changes. |
| page |
Specifies the page color in Reading mode. |
| page |
Specifies the page movement type. |
| reading |
Specifies whether margins are visible or hidden when the document is viewed in Full Screen Reading view. |
| revisions |
Gets whether Word displays revision balloons in the left or right margin in the document. |
| revisions |
Specifies the width of the revision balloons. |
| revisions |
Specifies how Microsoft Word measures the width of revision balloons. |
| seek |
Specifies the document element displayed in print layout view. |
| split |
Specifies the active window pane. |
| type | Specifies the view type. |
Property Details
areAllNonprintingCharactersDisplayed
Specifies whether all nonprinting characters are displayed.
areAllNonprintingCharactersDisplayed?: boolean;
Property Value
boolean
Remarks
areBackgroundsDisplayed
Gets whether background colors and images are shown when the document is displayed in print layout view.
areBackgroundsDisplayed?: boolean;
Property Value
boolean
Remarks
areBookmarksIndicated
Gets whether square brackets are displayed at the beginning and end of each bookmark.
areBookmarksIndicated?: boolean;
Property Value
boolean
Remarks
areCommentsDisplayed
Specifies whether Microsoft Word displays the comments in the document.
areCommentsDisplayed?: boolean;
Property Value
boolean
Remarks
areConnectingLinesToRevisionsBalloonDisplayed
Specifies whether Microsoft Word displays connecting lines from the text to the revision and comment balloons.
areConnectingLinesToRevisionsBalloonDisplayed?: boolean;
Property Value
boolean
Remarks
areCropMarksDisplayed
Gets whether crop marks are shown in the corners of pages to indicate where margins are located.
areCropMarksDisplayed?: boolean;
Property Value
boolean
Remarks
areDrawingsDisplayed
Gets whether objects created with the drawing tools are displayed in print layout view.
areDrawingsDisplayed?: boolean;
Property Value
boolean
Remarks
areEditableRangesShaded
Specifies whether shading is applied to the ranges in the document that users have permission to modify.
areEditableRangesShaded?: boolean;
Property Value
boolean
Remarks
areFieldCodesDisplayed
Specifies whether field codes are displayed.
areFieldCodesDisplayed?: boolean;
Property Value
boolean
Remarks
areFormatChangesDisplayed
Specifies whether Microsoft Word displays formatting changes made to the document with Track Changes enabled.
areFormatChangesDisplayed?: boolean;
Property Value
boolean
Remarks
areInkAnnotationsDisplayed
Specifies whether handwritten ink annotations are shown or hidden.
areInkAnnotationsDisplayed?: boolean;
Property Value
boolean
Remarks
areInsertionsAndDeletionsDisplayed
Specifies whether Microsoft Word displays insertions and deletions made to the document with Track Changes enabled.
areInsertionsAndDeletionsDisplayed?: boolean;
Property Value
boolean
Remarks
areLinesWrappedToWindow
Gets whether lines wrap at the right edge of the document window rather than at the right margin or the right column boundary.
areLinesWrappedToWindow?: boolean;
Property Value
boolean
Remarks
areObjectAnchorsDisplayed
Gets whether object anchors are displayed next to items that can be positioned in print layout view.
areObjectAnchorsDisplayed?: boolean;
Property Value
boolean
Remarks
areOptionalBreaksDisplayed
Gets whether Microsoft Word displays optional line breaks.
areOptionalBreaksDisplayed?: boolean;
Property Value
boolean
Remarks
areOptionalHyphensDisplayed
Gets whether optional hyphens are displayed.
areOptionalHyphensDisplayed?: boolean;
Property Value
boolean
Remarks
areOtherAuthorsVisible
Gets whether other authors' presence should be visible in the document.
areOtherAuthorsVisible?: boolean;
Property Value
boolean
Remarks
arePageBoundariesDisplayed
Gets whether the top and bottom margins and the gray area between pages in the document are displayed.
arePageBoundariesDisplayed?: boolean;
Property Value
boolean
Remarks
areParagraphsMarksDisplayed
Gets whether paragraph marks are displayed.
areParagraphsMarksDisplayed?: boolean;
Property Value
boolean
Remarks
arePicturePlaceholdersDisplayed
Gets whether blank boxes are displayed as placeholders for pictures.
arePicturePlaceholdersDisplayed?: boolean;
Property Value
boolean
Remarks
areRevisionsAndCommentsDisplayed
Specifies whether Microsoft Word displays revisions and comments made to the document with Track Changes enabled.
areRevisionsAndCommentsDisplayed?: boolean;
Property Value
boolean
Remarks
areSpacesIndicated
Gets whether space characters are displayed.
areSpacesIndicated?: boolean;
Property Value
boolean
Remarks
areTableGridlinesDisplayed
Specifies whether table gridlines are displayed.
areTableGridlinesDisplayed?: boolean;
Property Value
boolean
Remarks
areTabsDisplayed
Gets whether tab characters are displayed.
areTabsDisplayed?: boolean;
Property Value
boolean
Remarks
areTextBoundariesDisplayed
Gets whether dotted lines are displayed around page margins, text columns, objects, and frames in print layout view.
areTextBoundariesDisplayed?: boolean;
Property Value
boolean
Remarks
columnWidth
Specifies the column width in Reading mode.
columnWidth?: Word.ColumnWidth | "Narrow" | "Default" | "Wide";
Property Value
Word.ColumnWidth | "Narrow" | "Default" | "Wide"
Remarks
fieldShading
Gets on-screen shading for fields.
fieldShading?: Word.FieldShading | "Never" | "Always" | "WhenSelected";
Property Value
Word.FieldShading | "Never" | "Always" | "WhenSelected"
Remarks
isDraft
Specifies whether all the text in a window is displayed in the same sans-serif font with minimal formatting to speed up display.
isDraft?: boolean;
Property Value
boolean
Remarks
isFirstLineOnlyDisplayed
Specifies whether only the first line of body text is shown in outline view.
isFirstLineOnlyDisplayed?: boolean;
Property Value
boolean
Remarks
isFormatDisplayed
Specifies whether character formatting is visible in outline view.
isFormatDisplayed?: boolean;
Property Value
boolean
Remarks
isFullScreen
Specifies whether the window is in full-screen view.
isFullScreen?: boolean;
Property Value
boolean
Remarks
isHiddenTextDisplayed
Gets whether text formatted as hidden text is displayed.
isHiddenTextDisplayed?: boolean;
Property Value
boolean
Remarks
isHighlightingDisplayed
Gets whether highlight formatting is displayed and printed with the document.
isHighlightingDisplayed?: boolean;
Property Value
boolean
Remarks
isInConflictMode
Specifies whether the document is in conflict mode view.
isInConflictMode?: boolean;
Property Value
boolean
Remarks
isInPanning
Specifies whether Microsoft Word is in Panning mode.
isInPanning?: boolean;
Property Value
boolean
Remarks
isInReadingLayout
Specifies whether the document is being viewed in reading layout view.
isInReadingLayout?: boolean;
Property Value
boolean
Remarks
isMailMergeDataView
Specifies whether mail merge data is displayed instead of mail merge fields.
isMailMergeDataView?: boolean;
Property Value
boolean
Remarks
isMainTextLayerVisible
Specifies whether the text in the document is visible when the header and footer areas are displayed.
isMainTextLayerVisible?: boolean;
Property Value
boolean
Remarks
isPointerShownAsMagnifier
Specifies whether the pointer is displayed as a magnifying glass in print preview.
isPointerShownAsMagnifier?: boolean;
Property Value
boolean
Remarks
isReadingLayoutActualView
Specifies whether pages displayed in reading layout view are displayed using the same layout as printed pages.
isReadingLayoutActualView?: boolean;
Property Value
boolean
Remarks
isXmlMarkupVisible
Specifies whether XML tags are visible in the document.
isXmlMarkupVisible?: boolean;
Property Value
boolean
Remarks
markupMode
Specifies the display mode for tracked changes.
markupMode?: Word.RevisionsMode | "Balloon" | "Inline" | "Mixed";
Property Value
Word.RevisionsMode | "Balloon" | "Inline" | "Mixed"
Remarks
pageColor
Specifies the page color in Reading mode.
pageColor?: Word.PageColor | "None" | "Sepia" | "Inverse";
Property Value
Word.PageColor | "None" | "Sepia" | "Inverse"
Remarks
pageMovementType
Specifies the page movement type.
pageMovementType?: Word.PageMovementType | "Vertical" | "SideToSide";
Property Value
Word.PageMovementType | "Vertical" | "SideToSide"
Remarks
readingLayoutTruncateMargins
Specifies whether margins are visible or hidden when the document is viewed in Full Screen Reading view.
readingLayoutTruncateMargins?: Word.ReadingLayoutMargin | "Automatic" | "Suppress" | "Full";
Property Value
Word.ReadingLayoutMargin | "Automatic" | "Suppress" | "Full"
Remarks
revisionsBalloonSide
Gets whether Word displays revision balloons in the left or right margin in the document.
revisionsBalloonSide?: Word.RevisionsBalloonMargin | "Left" | "Right";
Property Value
Word.RevisionsBalloonMargin | "Left" | "Right"
Remarks
revisionsBalloonWidth
Specifies the width of the revision balloons.
revisionsBalloonWidth?: number;
Property Value
number
Remarks
revisionsBalloonWidthType
Specifies how Microsoft Word measures the width of revision balloons.
revisionsBalloonWidthType?: Word.RevisionsBalloonWidthType | "Percent" | "Points";
Property Value
Word.RevisionsBalloonWidthType | "Percent" | "Points"
Remarks
seekView
Specifies the document element displayed in print layout view.
seekView?: Word.SeekView | "MainDocument" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "CurrentPageHeader" | "CurrentPageFooter";
Property Value
Word.SeekView | "MainDocument" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "CurrentPageHeader" | "CurrentPageFooter"
Remarks
splitSpecial
Specifies the active window pane.
splitSpecial?: Word.SpecialPane | "None" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "FootnoteContinuationNotice" | "FootnoteContinuationSeparator" | "FootnoteSeparator" | "EndnoteContinuationNotice" | "EndnoteContinuationSeparator" | "EndnoteSeparator" | "Comments" | "CurrentPageHeader" | "CurrentPageFooter" | "Revisions" | "RevisionsHoriz" | "RevisionsVert";
Property Value
Word.SpecialPane | "None" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "FootnoteContinuationNotice" | "FootnoteContinuationSeparator" | "FootnoteSeparator" | "EndnoteContinuationNotice" | "EndnoteContinuationSeparator" | "EndnoteSeparator" | "Comments" | "CurrentPageHeader" | "CurrentPageFooter" | "Revisions" | "RevisionsHoriz" | "RevisionsVert"
Remarks
type
Specifies the view type.
type?: Word.ViewType | "Normal" | "Outline" | "Print" | "PrintPreview" | "Master" | "Web" | "Reading" | "Conflict";
Property Value
Word.ViewType | "Normal" | "Outline" | "Print" | "PrintPreview" | "Master" | "Web" | "Reading" | "Conflict"