Edit

Share via


Word.Interfaces.ViewData interface

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

Properties

areAllNonprintingCharactersDisplayed

Specifies whether all nonprinting characters are displayed.

areBackgroundsDisplayed

Gets whether background colors and images are shown when the document is displayed in print layout view.

areBookmarksIndicated

Gets whether square brackets are displayed at the beginning and end of each bookmark.

areCommentsDisplayed

Specifies whether Microsoft Word displays the comments in the document.

areConnectingLinesToRevisionsBalloonDisplayed

Specifies whether Microsoft Word displays connecting lines from the text to the revision and comment balloons.

areCropMarksDisplayed

Gets whether crop marks are shown in the corners of pages to indicate where margins are located.

areDrawingsDisplayed

Gets whether objects created with the drawing tools are displayed in print layout view.

areEditableRangesShaded

Specifies whether shading is applied to the ranges in the document that users have permission to modify.

areFieldCodesDisplayed

Specifies whether field codes are displayed.

areFormatChangesDisplayed

Specifies whether Microsoft Word displays formatting changes made to the document with Track Changes enabled.

areInkAnnotationsDisplayed

Specifies whether handwritten ink annotations are shown or hidden.

areInsertionsAndDeletionsDisplayed

Specifies whether Microsoft Word displays insertions and deletions made to the document with Track Changes enabled.

areLinesWrappedToWindow

Gets whether lines wrap at the right edge of the document window rather than at the right margin or the right column boundary.

areObjectAnchorsDisplayed

Gets whether object anchors are displayed next to items that can be positioned in print layout view.

areOptionalBreaksDisplayed

Gets whether Microsoft Word displays optional line breaks.

areOptionalHyphensDisplayed

Gets whether optional hyphens are displayed.

areOtherAuthorsVisible

Gets whether other authors' presence should be visible in the document.

arePageBoundariesDisplayed

Gets whether the top and bottom margins and the gray area between pages in the document are displayed.

areParagraphsMarksDisplayed

Gets whether paragraph marks are displayed.

arePicturePlaceholdersDisplayed

Gets whether blank boxes are displayed as placeholders for pictures.

areRevisionsAndCommentsDisplayed

Specifies whether Microsoft Word displays revisions and comments made to the document with Track Changes enabled.

areSpacesIndicated

Gets whether space characters are displayed.

areTableGridlinesDisplayed

Specifies whether table gridlines are displayed.

areTabsDisplayed

Gets whether tab characters are displayed.

areTextBoundariesDisplayed

Gets whether dotted lines are displayed around page margins, text columns, objects, and frames in print layout view.

columnWidth

Specifies the column width in Reading mode.

fieldShading

Gets on-screen shading for fields.

isDraft

Specifies whether all the text in a window is displayed in the same sans-serif font with minimal formatting to speed up display.

isFirstLineOnlyDisplayed

Specifies whether only the first line of body text is shown in outline view.

isFormatDisplayed

Specifies whether character formatting is visible in outline view.

isFullScreen

Specifies whether the window is in full-screen view.

isHiddenTextDisplayed

Gets whether text formatted as hidden text is displayed.

isHighlightingDisplayed

Gets whether highlight formatting is displayed and printed with the document.

isInConflictMode

Specifies whether the document is in conflict mode view.

isInPanning

Specifies whether Microsoft Word is in Panning mode.

isInReadingLayout

Specifies whether the document is being viewed in reading layout view.

isMailMergeDataView

Specifies whether mail merge data is displayed instead of mail merge fields.

isMainTextLayerVisible

Specifies whether the text in the document is visible when the header and footer areas are displayed.

isPointerShownAsMagnifier

Specifies whether the pointer is displayed as a magnifying glass in print preview.

isReadingLayoutActualView

Specifies whether pages displayed in reading layout view are displayed using the same layout as printed pages.

isXmlMarkupVisible

Specifies whether XML tags are visible in the document.

markupMode

Specifies the display mode for tracked changes.

pageColor

Specifies the page color in Reading mode.

pageMovementType

Specifies the page movement type.

readingLayoutTruncateMargins

Specifies whether margins are visible or hidden when the document is viewed in Full Screen Reading view.

revisionsBalloonSide

Gets whether Word displays revision balloons in the left or right margin in the document.

revisionsBalloonWidth

Specifies the width of the revision balloons.

revisionsBalloonWidthType

Specifies how Microsoft Word measures the width of revision balloons.

seekView

Specifies the document element displayed in print layout view.

splitSpecial

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

[ API set: WordApiDesktop 1.4 ]

areBackgroundsDisplayed

Gets whether background colors and images are shown when the document is displayed in print layout view.

areBackgroundsDisplayed?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

areBookmarksIndicated

Gets whether square brackets are displayed at the beginning and end of each bookmark.

areBookmarksIndicated?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

areCommentsDisplayed

Specifies whether Microsoft Word displays the comments in the document.

areCommentsDisplayed?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

areConnectingLinesToRevisionsBalloonDisplayed

Specifies whether Microsoft Word displays connecting lines from the text to the revision and comment balloons.

areConnectingLinesToRevisionsBalloonDisplayed?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

areCropMarksDisplayed

Gets whether crop marks are shown in the corners of pages to indicate where margins are located.

areCropMarksDisplayed?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

areDrawingsDisplayed

Gets whether objects created with the drawing tools are displayed in print layout view.

areDrawingsDisplayed?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

areEditableRangesShaded

Specifies whether shading is applied to the ranges in the document that users have permission to modify.

areEditableRangesShaded?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

areFieldCodesDisplayed

Specifies whether field codes are displayed.

areFieldCodesDisplayed?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

areFormatChangesDisplayed

Specifies whether Microsoft Word displays formatting changes made to the document with Track Changes enabled.

areFormatChangesDisplayed?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

areInkAnnotationsDisplayed

Specifies whether handwritten ink annotations are shown or hidden.

areInkAnnotationsDisplayed?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

areInsertionsAndDeletionsDisplayed

Specifies whether Microsoft Word displays insertions and deletions made to the document with Track Changes enabled.

areInsertionsAndDeletionsDisplayed?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

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

[ API set: WordApiDesktop 1.4 ]

areObjectAnchorsDisplayed

Gets whether object anchors are displayed next to items that can be positioned in print layout view.

areObjectAnchorsDisplayed?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

areOptionalBreaksDisplayed

Gets whether Microsoft Word displays optional line breaks.

areOptionalBreaksDisplayed?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

areOptionalHyphensDisplayed

Gets whether optional hyphens are displayed.

areOptionalHyphensDisplayed?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

areOtherAuthorsVisible

Gets whether other authors' presence should be visible in the document.

areOtherAuthorsVisible?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

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

[ API set: WordApiDesktop 1.4 ]

areParagraphsMarksDisplayed

Gets whether paragraph marks are displayed.

areParagraphsMarksDisplayed?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

arePicturePlaceholdersDisplayed

Gets whether blank boxes are displayed as placeholders for pictures.

arePicturePlaceholdersDisplayed?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

areRevisionsAndCommentsDisplayed

Specifies whether Microsoft Word displays revisions and comments made to the document with Track Changes enabled.

areRevisionsAndCommentsDisplayed?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

areSpacesIndicated

Gets whether space characters are displayed.

areSpacesIndicated?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

areTableGridlinesDisplayed

Specifies whether table gridlines are displayed.

areTableGridlinesDisplayed?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

areTabsDisplayed

Gets whether tab characters are displayed.

areTabsDisplayed?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

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

[ API set: WordApiDesktop 1.4 ]

columnWidth

Specifies the column width in Reading mode.

columnWidth?: Word.ColumnWidth | "Narrow" | "Default" | "Wide";

Property Value

Word.ColumnWidth | "Narrow" | "Default" | "Wide"

Remarks

[ API set: WordApiDesktop 1.4 ]

fieldShading

Gets on-screen shading for fields.

fieldShading?: Word.FieldShading | "Never" | "Always" | "WhenSelected";

Property Value

Word.FieldShading | "Never" | "Always" | "WhenSelected"

Remarks

[ API set: WordApiDesktop 1.4 ]

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

[ API set: WordApiDesktop 1.4 ]

isFirstLineOnlyDisplayed

Specifies whether only the first line of body text is shown in outline view.

isFirstLineOnlyDisplayed?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

isFormatDisplayed

Specifies whether character formatting is visible in outline view.

isFormatDisplayed?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

isFullScreen

Specifies whether the window is in full-screen view.

isFullScreen?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

isHiddenTextDisplayed

Gets whether text formatted as hidden text is displayed.

isHiddenTextDisplayed?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

isHighlightingDisplayed

Gets whether highlight formatting is displayed and printed with the document.

isHighlightingDisplayed?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

isInConflictMode

Specifies whether the document is in conflict mode view.

isInConflictMode?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

isInPanning

Specifies whether Microsoft Word is in Panning mode.

isInPanning?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

isInReadingLayout

Specifies whether the document is being viewed in reading layout view.

isInReadingLayout?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

isMailMergeDataView

Specifies whether mail merge data is displayed instead of mail merge fields.

isMailMergeDataView?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

isMainTextLayerVisible

Specifies whether the text in the document is visible when the header and footer areas are displayed.

isMainTextLayerVisible?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

isPointerShownAsMagnifier

Specifies whether the pointer is displayed as a magnifying glass in print preview.

isPointerShownAsMagnifier?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

isReadingLayoutActualView

Specifies whether pages displayed in reading layout view are displayed using the same layout as printed pages.

isReadingLayoutActualView?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

isXmlMarkupVisible

Specifies whether XML tags are visible in the document.

isXmlMarkupVisible?: boolean;

Property Value

boolean

Remarks

[ API set: WordApiDesktop 1.4 ]

markupMode

Specifies the display mode for tracked changes.

markupMode?: Word.RevisionsMode | "Balloon" | "Inline" | "Mixed";

Property Value

Word.RevisionsMode | "Balloon" | "Inline" | "Mixed"

Remarks

[ API set: WordApiDesktop 1.4 ]

pageColor

Specifies the page color in Reading mode.

pageColor?: Word.PageColor | "None" | "Sepia" | "Inverse";

Property Value

Word.PageColor | "None" | "Sepia" | "Inverse"

Remarks

[ API set: WordApiDesktop 1.4 ]

pageMovementType

Specifies the page movement type.

pageMovementType?: Word.PageMovementType | "Vertical" | "SideToSide";

Property Value

Word.PageMovementType | "Vertical" | "SideToSide"

Remarks

[ API set: WordApiDesktop 1.4 ]

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

[ API set: WordApiDesktop 1.4 ]

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

[ API set: WordApiDesktop 1.4 ]

revisionsBalloonWidth

Specifies the width of the revision balloons.

revisionsBalloonWidth?: number;

Property Value

number

Remarks

[ API set: WordApiDesktop 1.4 ]

revisionsBalloonWidthType

Specifies how Microsoft Word measures the width of revision balloons.

revisionsBalloonWidthType?: Word.RevisionsBalloonWidthType | "Percent" | "Points";

Property Value

Word.RevisionsBalloonWidthType | "Percent" | "Points"

Remarks

[ API set: WordApiDesktop 1.4 ]

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

[ API set: WordApiDesktop 1.4 ]

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

[ API set: WordApiDesktop 1.4 ]

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"

Remarks

[ API set: WordApiDesktop 1.4 ]