Word.View class

包含窗口或窗格的视图属性(如全部显示、域底纹和网格线)。

扩展

属性

areAllNonprintingCharactersDisplayed

指定是否显示所有非打印字符。

areBackgroundsDisplayed

获取文档在页面视图中显示时是否显示背景色和图像。

areBookmarksIndicated

获取是否在每个书签的开头和末尾显示方括号。

areCommentsDisplayed

指定 Microsoft Word 是否在文档中显示注释。

areConnectingLinesToRevisionsBalloonDisplayed

指定 Microsoft Word 是否显示从文本到修订和注释气球的连接行。

areCropMarksDisplayed

获取裁剪标记是否显示在页面的角落以指示页边距所在的位置。

areDrawingsDisplayed

获取使用绘图工具创建的对象是否显示在打印布局视图中。

areEditableRangesShaded

指定底纹是否应用于用户有权修改的文档中的范围。

areFieldCodesDisplayed

指定是否显示域代码。

areFormatChangesDisplayed

指定 Microsoft Word 是否在启用“跟踪修订”的情况下显示对文档所做的格式更改。

areInkAnnotationsDisplayed

指定是显示还是隐藏手写墨迹批注。

areInsertionsAndDeletionsDisplayed

指定 Microsoft Word 是否在启用“修订”的情况下显示对文档所做的插入和删除。

areLinesWrappedToWindow

获取行是否在文档窗口的右边缘换行,而不是在右边距或右列边界处换行。

areObjectAnchorsDisplayed

获取对象定位点是否显示在可在页面视图中定位的项旁边。

areOptionalBreaksDisplayed

获取 Microsoft Word 是否显示可选换行符。

areOptionalHyphensDisplayed

获取是否显示可选连字符。

areOtherAuthorsVisible

获取其他作者的状态是否应在文档中可见。

arePageBoundariesDisplayed

获取是否显示文档中的上下页边距和页面之间的灰色区域。

areParagraphsMarksDisplayed

获取是否显示段落标记。

arePicturePlaceholdersDisplayed

获取空白框是否显示为图片的占位符。

areRevisionsAndCommentsDisplayed

指定 Microsoft Word 是否在启用“跟踪更改”的情况下显示对文档所做的修订和注释。

areSpacesIndicated

获取是否显示空格字符。

areTableGridlinesDisplayed

指定是否显示表网格线。

areTabsDisplayed

获取是否显示制表符。

areTextBoundariesDisplayed

获取在页面视图中是否在页边距、文本列、对象和框架周围显示虚线。

columnWidth

指定阅读模式下的列宽。

context

与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。

fieldShading

获取字段的屏幕底纹。

isDraft

指定窗口中的所有文本是否以相同的无衬线字体显示,并采用最少的格式以加快显示速度。

isFirstLineOnlyDisplayed

指定是否在大纲视图中仅显示正文文本的第一行。

isFormatDisplayed

指定字符格式在大纲视图中是否可见。

isFullScreen

指定窗口是否处于全屏视图。

isHiddenTextDisplayed

获取是否显示格式化为隐藏文本的文本。

isHighlightingDisplayed

获取是否与文档一起显示和打印突出显示格式。

isInConflictMode

指定文档是否处于冲突模式视图。

isInPanning

指定 Microsoft Word 是否处于平移模式。

isInReadingLayout

指定是否在阅读布局视图中查看文档。

isMailMergeDataView

指定是否显示邮件合并数据,而不是邮件合并字段。

isMainTextLayerVisible

指定在显示页眉和页脚区域时文档中的文本是否可见。

isPointerShownAsMagnifier

指定指针是否在打印预览中显示为放大镜。

isReadingLayoutActualView

指定是否使用与打印页面相同的布局显示阅读布局视图中显示的页面。

isXmlMarkupVisible

指定 XML 标记在文档中是否可见。

markupMode

指定跟踪更改的显示模式。

pageColor

指定阅读模式下的页面颜色。

pageMovementType

指定页面移动类型。

readingLayoutTruncateMargins

指定在全屏阅读视图中查看文档时,边距是可见还是隐藏。

revisionsBalloonSide

获取 Word 在文档的左边距还是右边距显示修订气球。

revisionsBalloonWidth

指定修订气球的宽度。

revisionsBalloonWidthType

指定 Microsoft Word 度量修订气球宽度的方式。

revisionsFilter

获取对象的 RevisionsFilter 实例。

seekView

指定页面视图中显示的文档元素。

splitSpecial

指定活动窗口窗格。

type

指定视图类型。

方法

collapseAllHeadings()

折叠文档中的所有标题。

collapseOutline(range)

将选定内容或指定范围内的正文折叠一个标题级别。

expandAllHeadings()

展开文档中的所有标题。

expandOutline(range)

按照一个标题级别展开选定内容下的文本。

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

nextHeaderFooter()

根据视图中显示的是页眉还是页脚,移动到下一页眉或页脚。

previousHeaderFooter()

根据视图中显示的是页眉还是页脚,移动到前一页眉或页脚。

set(properties, options)

同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象,也可以传递另一个相同类型的 API 对象。

set(properties)

基于现有加载的对象,同时在对象上设置多个属性。

showAllHeadings()

在显示所有文本(包括标题和正文)和仅显示标题之间切换。

showHeading(level)

显示所有高于指定标题级别的标题,隐藏子标题和正文。

toJSON()

覆盖 JavaScript toJSON() 方法,以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Word.View 对象是 API 对象, toJSON 但该方法返回一个纯 JavaScript 对象, (类型化为 Word.Interfaces.ViewData) ,其中包含从原始对象加载的任何子属性的浅层副本。

track()

根据文档中的相应更改来跟踪对象,以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果在调用中 .sync 使用此对象,并且在“.run”批处理的顺序执行之外使用此对象,并且在设置属性或对对象调用方法时收到“InvalidObjectPath”错误,则需要在首次创建对象时将对象添加到跟踪对象集合。 如果此对象是集合的一部分,您还应跟踪父集合。

untrack()

释放与此对象关联的内存(如果先前已跟踪过)。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度,因此请在使用完毕后释放所添加的任何对象。 需要在内存释放生效之前调用 context.sync() 。

属性详细信息

areAllNonprintingCharactersDisplayed

指定是否显示所有非打印字符。

areAllNonprintingCharactersDisplayed: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.4

areBackgroundsDisplayed

获取文档在页面视图中显示时是否显示背景色和图像。

areBackgroundsDisplayed: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.4

areBookmarksIndicated

获取是否在每个书签的开头和末尾显示方括号。

readonly areBookmarksIndicated: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.4

areCommentsDisplayed

指定 Microsoft Word 是否在文档中显示注释。

areCommentsDisplayed: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.4

areConnectingLinesToRevisionsBalloonDisplayed

指定 Microsoft Word 是否显示从文本到修订和注释气球的连接行。

areConnectingLinesToRevisionsBalloonDisplayed: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.4

areCropMarksDisplayed

获取裁剪标记是否显示在页面的角落以指示页边距所在的位置。

readonly areCropMarksDisplayed: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.4

areDrawingsDisplayed

获取使用绘图工具创建的对象是否显示在打印布局视图中。

readonly areDrawingsDisplayed: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.4

areEditableRangesShaded

指定底纹是否应用于用户有权修改的文档中的范围。

areEditableRangesShaded: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.4

areFieldCodesDisplayed

指定是否显示域代码。

areFieldCodesDisplayed: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.4

areFormatChangesDisplayed

指定 Microsoft Word 是否在启用“跟踪修订”的情况下显示对文档所做的格式更改。

areFormatChangesDisplayed: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.4

areInkAnnotationsDisplayed

指定是显示还是隐藏手写墨迹批注。

areInkAnnotationsDisplayed: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.4

areInsertionsAndDeletionsDisplayed

指定 Microsoft Word 是否在启用“修订”的情况下显示对文档所做的插入和删除。

areInsertionsAndDeletionsDisplayed: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.4

areLinesWrappedToWindow

获取行是否在文档窗口的右边缘换行,而不是在右边距或右列边界处换行。

readonly areLinesWrappedToWindow: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.4

areObjectAnchorsDisplayed

获取对象定位点是否显示在可在页面视图中定位的项旁边。

readonly areObjectAnchorsDisplayed: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.4

areOptionalBreaksDisplayed

获取 Microsoft Word 是否显示可选换行符。

readonly areOptionalBreaksDisplayed: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.4

areOptionalHyphensDisplayed

获取是否显示可选连字符。

readonly areOptionalHyphensDisplayed: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.4

areOtherAuthorsVisible

获取其他作者的状态是否应在文档中可见。

areOtherAuthorsVisible: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.4

arePageBoundariesDisplayed

获取是否显示文档中的上下页边距和页面之间的灰色区域。

readonly arePageBoundariesDisplayed: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.4

areParagraphsMarksDisplayed

获取是否显示段落标记。

readonly areParagraphsMarksDisplayed: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.4

arePicturePlaceholdersDisplayed

获取空白框是否显示为图片的占位符。

readonly arePicturePlaceholdersDisplayed: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.4

areRevisionsAndCommentsDisplayed

指定 Microsoft Word 是否在启用“跟踪更改”的情况下显示对文档所做的修订和注释。

areRevisionsAndCommentsDisplayed: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.4

areSpacesIndicated

获取是否显示空格字符。

readonly areSpacesIndicated: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.4

areTableGridlinesDisplayed

指定是否显示表网格线。

areTableGridlinesDisplayed: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.4

areTabsDisplayed

获取是否显示制表符。

readonly areTabsDisplayed: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.4

areTextBoundariesDisplayed

获取在页面视图中是否在页边距、文本列、对象和框架周围显示虚线。

readonly areTextBoundariesDisplayed: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.4

columnWidth

指定阅读模式下的列宽。

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

属性值

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

注解

API 集:WordApiDesktop 1.4

context

与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

fieldShading

获取字段的屏幕底纹。

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

属性值

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

注解

API 集:WordApiDesktop 1.4

isDraft

指定窗口中的所有文本是否以相同的无衬线字体显示,并采用最少的格式以加快显示速度。

isDraft: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.4

isFirstLineOnlyDisplayed

指定是否在大纲视图中仅显示正文文本的第一行。

isFirstLineOnlyDisplayed: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.4

isFormatDisplayed

指定字符格式在大纲视图中是否可见。

isFormatDisplayed: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.4

isFullScreen

指定窗口是否处于全屏视图。

isFullScreen: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.4

isHiddenTextDisplayed

获取是否显示格式化为隐藏文本的文本。

readonly isHiddenTextDisplayed: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.4

isHighlightingDisplayed

获取是否与文档一起显示和打印突出显示格式。

readonly isHighlightingDisplayed: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.4

isInConflictMode

指定文档是否处于冲突模式视图。

isInConflictMode: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.4

isInPanning

指定 Microsoft Word 是否处于平移模式。

isInPanning: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.4

isInReadingLayout

指定是否在阅读布局视图中查看文档。

isInReadingLayout: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.4

isMailMergeDataView

指定是否显示邮件合并数据,而不是邮件合并字段。

isMailMergeDataView: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.4

isMainTextLayerVisible

指定在显示页眉和页脚区域时文档中的文本是否可见。

isMainTextLayerVisible: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.4

isPointerShownAsMagnifier

指定指针是否在打印预览中显示为放大镜。

isPointerShownAsMagnifier: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.4

isReadingLayoutActualView

指定是否使用与打印页面相同的布局显示阅读布局视图中显示的页面。

isReadingLayoutActualView: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.4

isXmlMarkupVisible

指定 XML 标记在文档中是否可见。

isXmlMarkupVisible: boolean;

属性值

boolean

注解

API 集:WordApiDesktop 1.4

markupMode

指定跟踪更改的显示模式。

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

属性值

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

注解

API 集:WordApiDesktop 1.4

pageColor

指定阅读模式下的页面颜色。

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

属性值

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

注解

API 集:WordApiDesktop 1.4

pageMovementType

指定页面移动类型。

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

属性值

Word.PageMovementType | "Vertical" | "SideToSide"

注解

API 集:WordApiDesktop 1.4

readingLayoutTruncateMargins

指定在全屏阅读视图中查看文档时,边距是可见还是隐藏。

readingLayoutTruncateMargins: Word.ReadingLayoutMargin | "Automatic" | "Suppress" | "Full";

属性值

Word.ReadingLayoutMargin | "Automatic" | "Suppress" | "Full"

注解

API 集:WordApiDesktop 1.4

revisionsBalloonSide

获取 Word 在文档的左边距还是右边距显示修订气球。

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

属性值

Word.RevisionsBalloonMargin | "Left" | "Right"

注解

API 集:WordApiDesktop 1.4

revisionsBalloonWidth

指定修订气球的宽度。

revisionsBalloonWidth: number;

属性值

number

注解

API 集:WordApiDesktop 1.4

revisionsBalloonWidthType

指定 Microsoft Word 度量修订气球宽度的方式。

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

属性值

Word.RevisionsBalloonWidthType | "Percent" | "Points"

注解

API 集:WordApiDesktop 1.4

revisionsFilter

获取对象的 RevisionsFilter 实例。

readonly revisionsFilter: Word.RevisionsFilter;

属性值

注解

API 集:WordApiDesktop 1.4

seekView

指定页面视图中显示的文档元素。

seekView: Word.SeekView | "MainDocument" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "CurrentPageHeader" | "CurrentPageFooter";

属性值

Word.SeekView | "MainDocument" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "CurrentPageHeader" | "CurrentPageFooter"

注解

API 集:WordApiDesktop 1.4

splitSpecial

指定活动窗口窗格。

splitSpecial: Word.SpecialPane | "None" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "FootnoteContinuationNotice" | "FootnoteContinuationSeparator" | "FootnoteSeparator" | "EndnoteContinuationNotice" | "EndnoteContinuationSeparator" | "EndnoteSeparator" | "Comments" | "CurrentPageHeader" | "CurrentPageFooter" | "Revisions" | "RevisionsHoriz" | "RevisionsVert";

属性值

Word.SpecialPane | "None" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "FootnoteContinuationNotice" | "FootnoteContinuationSeparator" | "FootnoteSeparator" | "EndnoteContinuationNotice" | "EndnoteContinuationSeparator" | "EndnoteSeparator" | "Comments" | "CurrentPageHeader" | "CurrentPageFooter" | "Revisions" | "RevisionsHoriz" | "RevisionsVert"

注解

API 集:WordApiDesktop 1.4

type

指定视图类型。

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

属性值

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

注解

API 集:WordApiDesktop 1.4

方法详细信息

collapseAllHeadings()

折叠文档中的所有标题。

collapseAllHeadings(): void;

返回

void

注解

API 集:WordApiDesktop 1.4

collapseOutline(range)

将选定内容或指定范围内的正文折叠一个标题级别。

collapseOutline(range: Word.Range): void;

参数

range
Word.Range

Range指定要折叠的范围的对象。

返回

void

注解

API 集:WordApiDesktop 1.4

expandAllHeadings()

展开文档中的所有标题。

expandAllHeadings(): void;

返回

void

注解

API 集:WordApiDesktop 1.4

expandOutline(range)

按照一个标题级别展开选定内容下的文本。

expandOutline(range: Word.Range): void;

参数

range
Word.Range

Range指定要展开的范围的对象。

返回

void

注解

API 集:WordApiDesktop 1.4

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

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

参数

options
Word.Interfaces.ViewLoadOptions

为要加载的对象属性提供选项。

返回

load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

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

参数

propertyNames

string | string[]

指定要加载的属性的逗号分隔的字符串或字符串数组。

返回

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

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

参数

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串,以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。

返回

nextHeaderFooter()

根据视图中显示的是页眉还是页脚,移动到下一页眉或页脚。

nextHeaderFooter(): void;

返回

void

注解

API 集:WordApiDesktop 1.4

previousHeaderFooter()

根据视图中显示的是页眉还是页脚,移动到前一页眉或页脚。

previousHeaderFooter(): void;

返回

void

注解

API 集:WordApiDesktop 1.4

set(properties, options)

同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象,也可以传递另一个相同类型的 API 对象。

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

参数

properties
Word.Interfaces.ViewUpdateData

一个 JavaScript 对象,其属性与调用该方法的对象的属性同构结构。

options
OfficeExtension.UpdateOptions

提供一个选项,用于在 properties 对象尝试设置任何只读属性时禁止错误。

返回

void

set(properties)

基于现有加载的对象,同时在对象上设置多个属性。

set(properties: Word.View): void;

参数

properties
Word.View

返回

void

showAllHeadings()

在显示所有文本(包括标题和正文)和仅显示标题之间切换。

showAllHeadings(): void;

返回

void

注解

API 集:WordApiDesktop 1.4

showHeading(level)

显示所有高于指定标题级别的标题,隐藏子标题和正文。

showHeading(level: number): void;

参数

level

number

要显示的标题级别。

返回

void

注解

API 集:WordApiDesktop 1.4

toJSON()

覆盖 JavaScript toJSON() 方法,以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Word.View 对象是 API 对象, toJSON 但该方法返回一个纯 JavaScript 对象, (类型化为 Word.Interfaces.ViewData) ,其中包含从原始对象加载的任何子属性的浅层副本。

toJSON(): Word.Interfaces.ViewData;

返回

track()

根据文档中的相应更改来跟踪对象,以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果在调用中 .sync 使用此对象,并且在“.run”批处理的顺序执行之外使用此对象,并且在设置属性或对对象调用方法时收到“InvalidObjectPath”错误,则需要在首次创建对象时将对象添加到跟踪对象集合。 如果此对象是集合的一部分,您还应跟踪父集合。

track(): Word.View;

返回

untrack()

释放与此对象关联的内存(如果先前已跟踪过)。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度,因此请在使用完毕后释放所添加的任何对象。 需要在内存释放生效之前调用 context.sync() 。

untrack(): Word.View;

返回