Word.View class

Specifies whether all nonprinting characters are displayed.

areAllNonprintingCharactersDisplayed: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

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

areBackgroundsDisplayed: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

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

readonly areBookmarksIndicated: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

Specifies whether Microsoft Word displays the comments in the document.

areCommentsDisplayed: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

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

areConnectingLinesToRevisionsBalloonDisplayed: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

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

readonly areCropMarksDisplayed: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

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

readonly areDrawingsDisplayed: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

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

areEditableRangesShaded: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

Specifies whether field codes are displayed.

areFieldCodesDisplayed: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

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

areFormatChangesDisplayed: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

Specifies whether handwritten ink annotations are shown or hidden.

areInkAnnotationsDisplayed: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

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

areInsertionsAndDeletionsDisplayed: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

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

readonly areLinesWrappedToWindow: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

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

readonly areObjectAnchorsDisplayed: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

Gets whether Microsoft Word displays optional line breaks.

readonly areOptionalBreaksDisplayed: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

Gets whether optional hyphens are displayed.

readonly areOptionalHyphensDisplayed: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

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

areOtherAuthorsVisible: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

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

readonly arePageBoundariesDisplayed: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

Gets whether paragraph marks are displayed.

readonly areParagraphsMarksDisplayed: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

Gets whether blank boxes are displayed as placeholders for pictures.

readonly arePicturePlaceholdersDisplayed: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

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

areRevisionsAndCommentsDisplayed: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

Gets whether space characters are displayed.

readonly areSpacesIndicated: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

Specifies whether table gridlines are displayed.

areTableGridlinesDisplayed: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

Gets whether tab characters are displayed.

readonly areTabsDisplayed: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

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

readonly areTextBoundariesDisplayed: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

Specifies the column width in Reading mode.

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

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

Gets on-screen shading for fields.

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

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

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

Remarks

[ API set: WordApiDesktop 1.4 ]

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

isFirstLineOnlyDisplayed: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

Specifies whether character formatting is visible in outline view.

isFormatDisplayed: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

Specifies whether the window is in full-screen view.

isFullScreen: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

Gets whether text formatted as hidden text is displayed.

readonly isHiddenTextDisplayed: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

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

readonly isHighlightingDisplayed: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

Specifies whether the document is in conflict mode view.

isInConflictMode: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

Specifies whether Microsoft Word is in Panning mode.

isInPanning: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

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

isInReadingLayout: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

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

isMailMergeDataView: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

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

isMainTextLayerVisible: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

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

isPointerShownAsMagnifier: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

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

isReadingLayoutActualView: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

Specifies whether XML tags are visible in the document.

isXmlMarkupVisible: boolean;

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

Specifies the display mode for tracked changes.

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

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

Specifies the page color in Reading mode.

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

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

Specifies the page movement type.

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

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

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

Remarks

[ API set: WordApiDesktop 1.4 ]

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

readonly revisionsBalloonSide: Word.RevisionsBalloonMargin | "Left" | "Right";

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

Specifies the width of the revision balloons.

revisionsBalloonWidth: number;

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

Specifies how Microsoft Word measures the width of revision balloons.

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

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

Gets the instance of a RevisionsFilter object.

readonly revisionsFilter: Word.RevisionsFilter;

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

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

Remarks

[ API set: WordApiDesktop 1.4 ]

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

Remarks

[ API set: WordApiDesktop 1.4 ]

Specifies the view type.

type: Word.ViewType | "Normal" | "Outline" | "Print" | "PrintPreview" | "Master" | "Web" | "Reading" | "Conflict";

Property Value

Remarks

[ API set: WordApiDesktop 1.4 ]

Collapses all the headings in the document.

collapseAllHeadings(): void;

Returns

Remarks

[ API set: WordApiDesktop 1.4 ]

Collapses the text under the selection or the specified range by one heading level.

collapseOutline(range: Word.Range): void;

Parameters

Returns

Remarks

[ API set: WordApiDesktop 1.4 ]

Expands all the headings in the document.

expandAllHeadings(): void;

Returns

Remarks

[ API set: WordApiDesktop 1.4 ]

Expands the text under the selection by one heading level.

expandOutline(range: Word.Range): void;

Parameters

Returns

Remarks

[ API set: WordApiDesktop 1.4 ]

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(options?: Word.Interfaces.ViewLoadOptions): Word.View;

Parameters

Returns

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNames?: string | string[]): Word.View;

Parameters

Returns

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.View;

Parameters

Returns

Moves to the next header or footer, depending on whether a header or footer is displayed in the view.

nextHeaderFooter(): void;

Returns

Remarks

[ API set: WordApiDesktop 1.4 ]

Moves to the previous header or footer, depending on whether a header or footer is displayed in the view.

previousHeaderFooter(): void;

Returns

Remarks

[ API set: WordApiDesktop 1.4 ]

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties: Interfaces.ViewUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameters

Returns

Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Word.View): void;

Parameters

Returns

Switches between showing all text (headings and body text) and showing only headings.

showAllHeadings(): void;

Returns

Remarks

[ API set: WordApiDesktop 1.4 ]

Shows all headings up to the specified heading level and hides subordinate headings and body text.

showHeading(level: number): void;

Parameters

Returns

Remarks

[ API set: WordApiDesktop 1.4 ]

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original Word.View object is an API object, the toJSON method returns a plain JavaScript object (typed as Word.Interfaces.ViewData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Word.Interfaces.ViewData;

Returns

Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you're using this object across .sync calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.

track(): Word.View;

Returns

Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call context.sync() before the memory release takes effect.

untrack(): Word.View;

Returns