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。

类 域 说明
正文 insertContentControl (contentControlType？： Word。ContentControlType.richText |Word。ContentControlType.plainText |Word。ContentControlType.checkBox |Word。ContentControlType.dropDownList |Word。ContentControlType.comboBox |“RichText” |“PlainText” |“CheckBox” |“DropDownList” |“ComboBox”) 使用内容控件包装 Body 对象。
ComboBoxContentControl addListItem (displayText： string， value？： string， index？： number) 将新的列表项添加到此组合框内容控件，并返回Word。ContentControlListItem 对象。
deleteAllListItems () 删除此组合框内容控件中的所有列表项。
listItems 获取组合框内容控件中列表项的集合。
ContentControl comboBoxContentControl 如果内容控件的类型为“ComboBox”，则指定与组合框相关的数据。
dropDownListContentControl 如果内容控件的类型为“DropDownList”，则指定与下拉列表相关的数据。
resetState () 重置内容控件的状态。
setState (contentControlState： Word。ContentControlState) 设置内容控件的状态。
ContentControlListItem delete() 删除列表项。
displayText 指定下拉列表或组合框内容控件的列表项的显示文本。
index 指定列表项集合中内容控件列表项的索引位置。
select() 选择列表项，并将内容控件的文本设置为列表项的值。
value 为下拉列表或组合框内容控件指定列表项的编程值。
ContentControlListItemCollection getFirst() 获取此集合中的第一个列表项。
getFirstOrNullObject () 获取此集合中的第一个列表项。
items 获取此集合中已加载的子项。
DropDownListContentControl addListItem (displayText： string， value？： string， index？： number) 向此下拉列表内容控件添加新列表项，并返回Word。ContentControlListItem 对象。
deleteAllListItems () 删除此下拉列表内容控件中的所有列表项。
listItems 获取下拉列表内容控件中列表项的集合。
Font hidden 指定一个值，该值指示字体是否标记为隐藏。
List resetLevelFont (level： number， resetFontName？： boolean) 重置列表中指定级别的项目符号、数字或图片的字体。
Paragraph insertContentControl (contentControlType？： Word。ContentControlType.richText |Word。ContentControlType.plainText |Word。ContentControlType.checkBox |Word。ContentControlType.dropDownList |Word。ContentControlType.comboBox |“RichText” |“PlainText” |“CheckBox” |“DropDownList” |“ComboBox”) 使用内容控件包装 Paragraph 对象。
区域 insertContentControl (contentControlType？： Word。ContentControlType.richText |Word。ContentControlType.plainText |Word。ContentControlType.checkBox |Word。ContentControlType.dropDownList |Word。ContentControlType.comboBox |“RichText” |“PlainText” |“CheckBox” |“DropDownList” |“ComboBox”) 使用内容控件包装 Range 对象。
样式 description 获取指定样式的说明。

仅限 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 在选择批注时发生。

另请参阅