Word.View class
包含窗口或窗格的视图属性(如全部显示、域底纹和网格线)。
注解
属性
| are |
指定是否显示所有非打印字符。 |
| are |
获取在打印版式视图中显示文档时是否显示背景色和图像。 |
| are |
获取是否在每个书签的开头和末尾显示方括号。 |
| are |
指定Microsoft Word是否显示文档中的批注。 |
| are |
指定Microsoft Word是否显示从文本到修订和批注气球的连接线。 |
| are |
获取是否在页面的角落中显示裁剪标记,以指示边距所在的位置。 |
| are |
获取使用绘图工具创建的对象是否显示在打印布局视图中。 |
| are |
指定是否将底纹应用于文档中用户有权修改的区域。 |
| are |
指定是否显示域代码。 |
| are |
指定Microsoft Word是否显示对启用了修订的文档所做的格式设置更改。 |
| are |
指定是显示还是隐藏手写墨迹批注。 |
| are |
指定Microsoft Word是否显示对启用了修订的文档进行的插入和删除。 |
| are |
获取行是否在文档窗口的右边缘换行,而不是在右边距或右列边界换行。 |
| are |
获取对象定位点是否显示在可在打印布局视图中定位的项旁边。 |
| are |
获取Microsoft Word是否显示可选的换行符。 |
| are |
获取是否显示可选的连字符。 |
| are |
获取其他作者的状态是否应在文档中可见。 |
| are |
获取是否显示文档中页面之间的上边距和下边距以及灰色区域。 |
| are |
获取是否显示段落标记。 |
| are |
获取空白框是否显示为图片的占位符。 |
| are |
指定Microsoft Word是否显示对启用了修订的文档所做的修订和批注。 |
| are |
获取是否显示空格字符。 |
| are |
指定是否显示表网格线。 |
| are |
获取是否显示制表符。 |
| are |
获取是否在打印布局视图中的页边距、文本列、对象和框架周围显示虚线。 |
| column |
指定阅读模式下的列宽。 |
| context | 与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。 |
| field |
获取字段的屏幕底纹。 |
| is |
指定是否以相同的无衬线字体显示窗口中的所有文本,并且格式最小,以加快显示速度。 |
| is |
指定是否在大纲视图中仅显示正文文本的第一行。 |
| is |
指定字符格式在大纲视图中是否可见。 |
| is |
指定窗口是否处于全屏视图中。 |
| is |
获取是否显示格式化为隐藏文本的文本。 |
| is |
获取是否使用文档显示和打印突出显示格式。 |
| is |
指定文档是否处于冲突模式视图。 |
| is |
指定Microsoft Word是否处于平移模式。 |
| is |
指定是否在阅读布局视图中查看文档。 |
| is |
指定是否显示邮件合并数据而不是邮件合并字段。 |
| is |
指定在显示页眉和页脚区域时文档中的文本是否可见。 |
| is |
指定指针在打印预览中是否显示为放大镜。 |
| is |
指定是否使用与打印页相同的布局显示阅读布局视图中显示的页面。 |
| is |
指定 XML 标记在文档中是否可见。 |
| markup |
指定修订的显示模式。 |
| page |
指定阅读模式下的页面颜色。 |
| page |
指定页面移动类型。 |
| reading |
指定在全屏阅读视图中查看文档时边距是可见还是隐藏。 |
| revisions |
获取Word在文档中的左边距或右侧边距显示修订气球。 |
| revisions |
指定修订气球的宽度。 |
| revisions |
指定 Microsoft Word 度量修订气球宽度的方式。 |
| revisions |
获取 对象的实例 |
| seek |
指定在打印布局视图中显示的文档元素。 |
| split |
指定活动窗口窗格。 |
| type | 指定视图类型。 |
方法
| collapse |
折叠文档中的所有标题。 |
| collapse |
将选定内容或指定范围内的正文折叠一个标题级别。 |
| expand |
展开文档中的所有标题。 |
| expand |
按照一个标题级别展开选定内容下的文本。 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| next |
根据视图中显示的是页眉还是页脚,移动到下一页眉或页脚。 |
| previous |
根据视图中显示的是页眉还是页脚,移动到前一页眉或页脚。 |
| set(properties, options) | 同时设置对象的多个属性。 可以传递具有相应属性的纯对象,也可以传递同一类型的另一个 API 对象。 |
| set(properties) | 基于现有的已加载对象,同时对对象设置多个属性。 |
| show |
在显示所有文本(包括标题和正文)和仅显示标题之间切换。 |
| show |
显示所有高于指定标题级别的标题,隐藏子标题和正文。 |
| toJSON() | 重写 JavaScript |
| track() | 根据文档中的相应更改来跟踪对象,以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果跨 |
| untrack() | 释放与此对象关联的内存(如果先前已跟踪过)。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度,因此请在使用完毕后释放所添加的任何对象。 在内存发布生效之前,需要调用 |
属性详细信息
areAllNonprintingCharactersDisplayed
指定是否显示所有非打印字符。
areAllNonprintingCharactersDisplayed: boolean;
属性值
boolean
注解
areBackgroundsDisplayed
获取在打印版式视图中显示文档时是否显示背景色和图像。
areBackgroundsDisplayed: boolean;
属性值
boolean
注解
areBookmarksIndicated
获取是否在每个书签的开头和末尾显示方括号。
readonly areBookmarksIndicated: boolean;
属性值
boolean
注解
areCommentsDisplayed
指定Microsoft Word是否显示文档中的批注。
areCommentsDisplayed: boolean;
属性值
boolean
注解
areConnectingLinesToRevisionsBalloonDisplayed
指定Microsoft Word是否显示从文本到修订和批注气球的连接线。
areConnectingLinesToRevisionsBalloonDisplayed: boolean;
属性值
boolean
注解
areCropMarksDisplayed
获取是否在页面的角落中显示裁剪标记,以指示边距所在的位置。
readonly areCropMarksDisplayed: boolean;
属性值
boolean
注解
areDrawingsDisplayed
获取使用绘图工具创建的对象是否显示在打印布局视图中。
readonly areDrawingsDisplayed: boolean;
属性值
boolean
注解
areEditableRangesShaded
指定是否将底纹应用于文档中用户有权修改的区域。
areEditableRangesShaded: boolean;
属性值
boolean
注解
areFieldCodesDisplayed
areFormatChangesDisplayed
指定Microsoft Word是否显示对启用了修订的文档所做的格式设置更改。
areFormatChangesDisplayed: boolean;
属性值
boolean
注解
areInkAnnotationsDisplayed
areInsertionsAndDeletionsDisplayed
指定Microsoft Word是否显示对启用了修订的文档进行的插入和删除。
areInsertionsAndDeletionsDisplayed: boolean;
属性值
boolean
注解
areLinesWrappedToWindow
获取行是否在文档窗口的右边缘换行,而不是在右边距或右列边界换行。
readonly areLinesWrappedToWindow: boolean;
属性值
boolean
注解
areObjectAnchorsDisplayed
获取对象定位点是否显示在可在打印布局视图中定位的项旁边。
readonly areObjectAnchorsDisplayed: boolean;
属性值
boolean
注解
areOptionalBreaksDisplayed
获取Microsoft Word是否显示可选的换行符。
readonly areOptionalBreaksDisplayed: boolean;
属性值
boolean
注解
areOptionalHyphensDisplayed
获取是否显示可选的连字符。
readonly areOptionalHyphensDisplayed: boolean;
属性值
boolean
注解
areOtherAuthorsVisible
arePageBoundariesDisplayed
获取是否显示文档中页面之间的上边距和下边距以及灰色区域。
readonly arePageBoundariesDisplayed: boolean;
属性值
boolean
注解
areParagraphsMarksDisplayed
获取是否显示段落标记。
readonly areParagraphsMarksDisplayed: boolean;
属性值
boolean
注解
arePicturePlaceholdersDisplayed
获取空白框是否显示为图片的占位符。
readonly arePicturePlaceholdersDisplayed: boolean;
属性值
boolean
注解
areRevisionsAndCommentsDisplayed
指定Microsoft Word是否显示对启用了修订的文档所做的修订和批注。
areRevisionsAndCommentsDisplayed: boolean;
属性值
boolean
注解
areSpacesIndicated
areTableGridlinesDisplayed
areTabsDisplayed
areTextBoundariesDisplayed
获取是否在打印布局视图中的页边距、文本列、对象和框架周围显示虚线。
readonly areTextBoundariesDisplayed: boolean;
属性值
boolean
注解
columnWidth
指定阅读模式下的列宽。
columnWidth: Word.ColumnWidth | "Narrow" | "Default" | "Wide";
属性值
Word.ColumnWidth | "Narrow" | "Default" | "Wide"
注解
context
fieldShading
获取字段的屏幕底纹。
readonly fieldShading: Word.FieldShading | "Never" | "Always" | "WhenSelected";
属性值
Word.FieldShading | "Never" | "Always" | "WhenSelected"
注解
isDraft
指定是否以相同的无衬线字体显示窗口中的所有文本,并且格式最小,以加快显示速度。
isDraft: boolean;
属性值
boolean
注解
isFirstLineOnlyDisplayed
指定是否在大纲视图中仅显示正文文本的第一行。
isFirstLineOnlyDisplayed: boolean;
属性值
boolean
注解
isFormatDisplayed
isFullScreen
isHiddenTextDisplayed
获取是否显示格式化为隐藏文本的文本。
readonly isHiddenTextDisplayed: boolean;
属性值
boolean
注解
isHighlightingDisplayed
获取是否使用文档显示和打印突出显示格式。
readonly isHighlightingDisplayed: boolean;
属性值
boolean
注解
isInConflictMode
isInPanning
isInReadingLayout
isMailMergeDataView
isMainTextLayerVisible
指定在显示页眉和页脚区域时文档中的文本是否可见。
isMainTextLayerVisible: boolean;
属性值
boolean
注解
isPointerShownAsMagnifier
isReadingLayoutActualView
指定是否使用与打印页相同的布局显示阅读布局视图中显示的页面。
isReadingLayoutActualView: boolean;
属性值
boolean
注解
isXmlMarkupVisible
markupMode
指定修订的显示模式。
markupMode: Word.RevisionsMode | "Balloon" | "Inline" | "Mixed";
属性值
Word.RevisionsMode | "Balloon" | "Inline" | "Mixed"
注解
pageColor
指定阅读模式下的页面颜色。
pageColor: Word.PageColor | "None" | "Sepia" | "Inverse";
属性值
Word.PageColor | "None" | "Sepia" | "Inverse"
注解
pageMovementType
指定页面移动类型。
pageMovementType: Word.PageMovementType | "Vertical" | "SideToSide";
属性值
Word.PageMovementType | "Vertical" | "SideToSide"
注解
readingLayoutTruncateMargins
指定在全屏阅读视图中查看文档时边距是可见还是隐藏。
readingLayoutTruncateMargins: Word.ReadingLayoutMargin | "Automatic" | "Suppress" | "Full";
属性值
Word.ReadingLayoutMargin | "Automatic" | "Suppress" | "Full"
注解
revisionsBalloonSide
获取Word在文档中的左边距或右侧边距显示修订气球。
readonly revisionsBalloonSide: Word.RevisionsBalloonMargin | "Left" | "Right";
属性值
Word.RevisionsBalloonMargin | "Left" | "Right"
注解
revisionsBalloonWidth
revisionsBalloonWidthType
指定 Microsoft Word 度量修订气球宽度的方式。
revisionsBalloonWidthType: Word.RevisionsBalloonWidthType | "Percent" | "Points";
属性值
Word.RevisionsBalloonWidthType | "Percent" | "Points"
注解
revisionsFilter
获取 对象的实例 RevisionsFilter 。
readonly revisionsFilter: Word.RevisionsFilter;
属性值
注解
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"
注解
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"
注解
type
指定视图类型。
type: Word.ViewType | "Normal" | "Outline" | "Print" | "PrintPreview" | "Master" | "Web" | "Reading" | "Conflict";
属性值
Word.ViewType | "Normal" | "Outline" | "Print" | "PrintPreview" | "Master" | "Web" | "Reading" | "Conflict"
注解
方法详细信息
collapseAllHeadings()
collapseOutline(range)
将选定内容或指定范围内的正文折叠一个标题级别。
collapseOutline(range: Word.Range): void;
参数
- range
- Word.Range
一个 Range 对象,该对象指定要折叠的区域。
返回
void
注解
expandAllHeadings()
expandOutline(range)
按照一个标题级别展开选定内容下的文本。
expandOutline(range: Word.Range): void;
参数
- range
- Word.Range
一个 Range 对象,该对象指定要展开的范围。
返回
void
注解
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()
previousHeaderFooter()
set(properties, options)
同时设置对象的多个属性。 可以传递具有相应属性的纯对象,也可以传递同一类型的另一个 API 对象。
set(properties: Interfaces.ViewUpdateData, options?: OfficeExtension.UpdateOptions): void;
参数
- properties
- Word.Interfaces.ViewUpdateData
一个 JavaScript 对象,其属性按同构方式构造为调用方法的对象的属性。
- options
- OfficeExtension.UpdateOptions
提供一个选项,用于在 properties 对象尝试设置任何只读属性时禁止显示错误。
返回
void
set(properties)
showAllHeadings()
showHeading(level)
显示所有高于指定标题级别的标题,隐藏子标题和正文。
showHeading(level: number): void;
参数
- level
-
number
要显示的标题级别。
返回
void
注解
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;