Edit

Share via

Word.Interfaces.ViewUpdateData interface

Package:
word

An interface for updating data on the View object, for use in view.set({ ... }).

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.
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.
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.
areOtherAuthorsVisible

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

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

Specifies whether table gridlines are displayed.
columnWidth

Specifies the column width in Reading mode.
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.
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.
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

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 all nonprinting characters are displayed.

areAllNonprintingCharactersDisplayed?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

areBackgroundsDisplayed

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 whether background colors and images are shown when the document is displayed in print layout view.

areBackgroundsDisplayed?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

areCommentsDisplayed

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 Microsoft Word displays the comments in the document.

areCommentsDisplayed?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

areConnectingLinesToRevisionsBalloonDisplayed

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 Microsoft Word displays connecting lines from the text to the revision and comment balloons.

areConnectingLinesToRevisionsBalloonDisplayed?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

areEditableRangesShaded

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 shading is applied to the ranges in the document that users have permission to modify.

areEditableRangesShaded?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

areFieldCodesDisplayed

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 field codes are displayed.

areFieldCodesDisplayed?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

areFormatChangesDisplayed

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 Microsoft Word displays formatting changes made to the document with Track Changes enabled.

areFormatChangesDisplayed?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

areInkAnnotationsDisplayed

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 handwritten ink annotations are shown or hidden.

areInkAnnotationsDisplayed?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

areInsertionsAndDeletionsDisplayed

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 Microsoft Word displays insertions and deletions made to the document with Track Changes enabled.

areInsertionsAndDeletionsDisplayed?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

areOtherAuthorsVisible

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 whether other authors' presence should be visible in the document.

areOtherAuthorsVisible?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

areRevisionsAndCommentsDisplayed

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 Microsoft Word displays revisions and comments made to the document with Track Changes enabled.

areRevisionsAndCommentsDisplayed?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

areTableGridlinesDisplayed

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 table gridlines are displayed.

areTableGridlinesDisplayed?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

columnWidth

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 column width in Reading mode.

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

Property Value

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

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

isDraft

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 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: WordApi BETA (PREVIEW ONLY) ]

isFirstLineOnlyDisplayed

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 only the first line of body text is shown in outline view.

isFirstLineOnlyDisplayed?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

isFormatDisplayed

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 character formatting is visible in outline view.

isFormatDisplayed?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

isFullScreen

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 in full-screen view.

isFullScreen?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

isInConflictMode

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 is in conflict mode view.

isInConflictMode?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

isInPanning

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 Microsoft Word is in Panning mode.

isInPanning?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

isInReadingLayout

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 is being viewed in reading layout view.

isInReadingLayout?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

isMailMergeDataView

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 mail merge data is displayed instead of mail merge fields.

isMailMergeDataView?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

isMainTextLayerVisible

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 text in the document is visible when the header and footer areas are displayed.

isMainTextLayerVisible?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

isPointerShownAsMagnifier

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 pointer is displayed as a magnifying glass in print preview.

isPointerShownAsMagnifier?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

isReadingLayoutActualView

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 pages displayed in reading layout view are displayed using the same layout as printed pages.

isReadingLayoutActualView?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

isXmlMarkupVisible

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 XML tags are visible in the document.

isXmlMarkupVisible?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

markupMode

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 display mode for tracked changes.

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

Property Value

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

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

pageColor

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 page color in Reading mode.

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

Property Value

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

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

pageMovementType

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 page movement type.

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

Property Value

Word.PageMovementType | "Vertical" | "SideToSide"

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

readingLayoutTruncateMargins

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 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: WordApi BETA (PREVIEW ONLY) ]

revisionsBalloonWidth

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 revision balloons.

revisionsBalloonWidth?: number;

Property Value

number

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

revisionsBalloonWidthType

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 measures the width of revision balloons.

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

Property Value

Word.RevisionsBalloonWidthType | "Percent" | "Points"

Remarks

[ API set: WordApi BETA (PREVIEW ONLY) ]

seekView

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 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: WordApi BETA (PREVIEW ONLY) ]

splitSpecial

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 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: 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.

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: WordApi BETA (PREVIEW ONLY) ]