Word JavaScript 预览 API

  • 项目

新Word JavaScript API 首先在“预览版”中引入，然后在进行足够的测试并获取用户反馈后成为特定编号要求集的一部分。

重要

请注意，以下Word预览 API 可能在以下平台上可用。

  • Windows 版 Word
  • Mac 版 Word

iPad 目前不支持Word预览 API。 但是，Web 上的Word中也可能提供了多个 API。 有关仅在 web 上的 Word 中可用的 API，请参阅仅限 Web 的 API 列表。

注意

预览 API 可能会发生变更，不适合在生产环境中使用。 我们建议你仅在测试和开发环境中试用它们。 不要在生产环境或业务关键型文档中使用预览 API。

若要使用预览 API：

API 列表

下表列出了当前处于预览状态Word JavaScript API，但仅在 web 上的 Word 中可用的 API 除外。 若要查看所有Word JavaScript API 的完整列表， (包括预览 API 和以前发布的 API) ，请参阅所有Word JavaScript API。

类 域 说明
AnnotationPopupActionEventArgs action 指定弹出菜单中的所选操作。
critiqueSuggestion 指定接受的建议 (仅在接受批评建议时填充) 。
id 指定为其触发事件的批注 ID。
边框 color 指定边框的颜色。
location 获取边框的位置。
type 指定边框的边框类型。
visible 指定边框是否可见。
width 指定边框的宽度。
BorderCollection getByLocation (borderLocation：Word.BorderLocation.top |Word。BorderLocation.left |Word。BorderLocation.bottom |Word。BorderLocation.right |Word。BorderLocation.insideHorizontal |Word。BorderLocation.insideVertical |“Top” |“Left” |“Bottom” |“Right” |“InsideHorizontal” |“InsideVertical”) 获取具有指定位置的边框。
getFirst() 获取此集合中的第一个边框。
getFirstOrNullObject () 获取此集合中的第一个边框。
getItem(index: number) 按集合中的索引获取 Border 对象。
insideBorderColor 指定内部边框的 24 位颜色。
insideBorderType 指定内部边框的边框类型。
insideBorderWidth 指定内部边框的宽度。
items 获取此集合中已加载的子项。
outsideBorderColor 指定外部边框的 24 位颜色。
outsideBorderType 指定外边框的边框类型。
outsideBorderWidth 指定外边框的宽度。
ContentControlAddedEventArgs eventType 事件类型。
ContentControlDataChangedEventArgs eventType 事件类型。
ContentControlDeletedEventArgs eventType 事件类型。
ContentControlEnteredEventArgs eventType 事件类型。
ContentControlEventArgs contentControl 引发事件的 对象。
eventType 事件类型。
Id 获取内容控件 ID。
源 事件的源。
ContentControlExitedEventArgs eventType 事件类型。
ContentControlSelectionChangedEventArgs eventType 事件类型。
批判 popupOptions 指定批评弹出菜单的行为。
CritiquePopupOptions brandingTextResourceId 获取用于品牌打造的字符串的清单资源 ID。
subtitleResourceId 获取要用作副标题的字符串的清单资源 ID。
建议 获取要显示在批评弹出菜单中的建议。
titleResourceId 获取要用作标题的字符串的清单资源 ID。
"文档" 比较 (filePath： string， documentCompareOptions？： Word。DocumentCompareOptions) 显示修订标记，以表明指定的文档与另一个文档的区别。
onAnnotationPopupAction 当用户在批注弹出菜单中执行操作时发生。
DocumentCompareOptions addToRecentFiles True 将文档添加到 文件菜单上最近使用的文件列表。
authorName 与比较生成的区别相关联的审阅者姓名。
compareTarget 比较的目标文档。
detectFormatChanges 真 (默认值) 进行比较以包含检测到的格式更改。
ignoreAllComparisonWarnings 真正 比较文档，而不必通知用户有问题存在。
removeDateAndTime 为 日期和时间戳信息从修订中移除返回的 文档 对象中。
removePersonalInformation 如果为 True，则从返回的 Document 对象中的注释、修订和属性对话框中删除所有用户信息。
字段 showCodes 指定是否显示指定字段的域代码。
Font hidden 指定一个值，该值指示字体是否标记为隐藏。
InlinePicture imageFormat 获取内联图像的格式。
List getLevelFont (级别：数字) 获取列表中指定级别的项目符号、数字或图片的字体。
getLevelPicture (level： number) 获取列表中指定级别的图片的 Base64 编码字符串表示形式。
resetLevelFont (level： number， resetFontName？： boolean) 重置列表中指定级别的项目符号、数字或图片的字体。
setLevelPicture (级别： number， base64EncodedImage？： string) 在列表中的指定级别设置图片。
ListLevel 对准 指定列表级别的水平对齐方式。
font 获取一个 Font 对象，该对象表示指定对象的字符格式设置。
linkedStyle 指定链接到指定列表级别对象的样式的名称。
numberFormat 指定指定列表级别的数字格式。
numberPosition 指定指定列表级别对象的编号或项目符号) 位置 (以磅为单位。
numberStyle 指定列表级别对象的编号样式。
resetOnHigher 指定在指定的列表级别重新启动编号为 1 之前必须显示的列表级别。
startAt 指定指定列表级别对象的起始编号。
tabPosition 指定指定列表级别对象的选项卡位置。
textPosition 指定指定列表级别对象的第二行换行文本 () 的位置（以磅为单位）。
trailingCharacter 指定在指定列表级别的数字之后插入的字符。
ListLevelCollection getFirst() 获取此集合中的第一个列表级别。
getFirstOrNullObject () 获取此集合中的第一个列表级别。
items 获取此集合中已加载的子项。
ListTemplate listLevels 获取一个 ListLevels 集合，该集合代表指定 ListTemplate 的所有级别。
outlineNumbered 指定指定的 ListTemplate 对象是否为大纲编号。
ParagraphAddedEventArgs type 事件类型。
ParagraphChangedEventArgs type 事件类型。
ParagraphDeletedEventArgs type 事件类型。
区域 highlight () 在不更改文档内容的情况下暂时突出显示区域。
removeHighlight () 删除由 Highlight 函数添加的突出显示（如果有）。
Shading foregroundPatternColor 指定对象的前景的颜色。
纹理 指定对象的底纹纹理。
样式 Borders 指定一个 BorderCollection 对象，该对象代表指定样式的所有边框。
description 获取指定样式的说明。
listTemplate 获取一个 ListTemplate 对象，该对象代表指定 Style 对象的列表格式。
TableRow insertContentControl() 在行中插入内容控件。
TableStyle 对准 指定表与页边距的对齐方式。
allowBreakAcrossPage 指定用指定样式设置格式的表中的行是否跨页分隔。

仅限 Web 的 API 列表

下表列出了目前仅在 web Word 中处于预览状态的 javaScript API Word。 若要查看所有Word JavaScript API 的完整列表， (包括预览 API 和以前发布的 API) ，请参阅所有Word JavaScript API。

类 域 说明
正文 onCommentAdded 在添加新注释时发生。
onCommentChanged 更改批注或其回复时发生。
onCommentDeleted 删除批注时发生。
onCommentDeselected 在取消选择批注时发生。
onCommentSelected 在选择批注时发生。
CommentDetail id 表示此注释的 ID。
replyIds 表示对此批注的答复的 ID。
CommentEventArgs changeType 表示如何触发注释更改事件。
commentDetails 获取 CommentDetail 数组，其中包含所涉及注释的 ID 和回复 ID。
源 事件的源。
type 事件类型。
ContentControl onCommentAdded 在添加新注释时发生。
onCommentChanged 更改批注或其回复时发生。
onCommentDeselected 在取消选择批注时发生。
onCommentSelected 在选择批注时发生。
Paragraph onCommentAdded 在添加新注释时发生。
onCommentChanged 更改批注或其回复时发生。
onCommentDeleted 删除批注时发生。
onCommentDeselected 在取消选择批注时发生。
onCommentSelected 在选择批注时发生。
区域 onCommentAdded 在添加新注释时发生。
onCommentChanged 更改批注或其回复时发生。
onCommentDeselected 在取消选择批注时发生。
onCommentSelected 在选择批注时发生。

另请参阅