通过

Word JavaScript API 1.7 中的新增功能

  • 项目

WordApi 1.7 主要添加了对编写帮助的支持。

重要

注释 API 需要 Microsoft 365 订阅才能正常工作，因为基础服务的要求。 有关此内容的详细信息，请参阅 GitHub 问题 4953。

API 列表

下表列出了 Word JavaScript API 要求集 1.7 中的 API。 若要查看Word JavaScript API 要求集 1.7 或更低版本支持的所有 API 的 API 参考文档，请参阅要求集 1.7 或更低版本中Word API。

类 域 说明
Annotation critiqueAnnotation 获取批注对象。
delete() 删除批注。
id 获取唯一标识符，该标识符用于更轻松地跟踪 Annotation 对象。
state 获取批注的状态。
AnnotationClickedEventArgs id 指定为其触发事件的批注 ID。
AnnotationCollection getFirst() 获取此集合中的第一个批注。
getFirstOrNullObject () 获取此集合中的第一个批注。
items 获取此集合中已加载的子项。
AnnotationHoveredEventArgs id 指定为其触发事件的批注 ID。
AnnotationInsertedEventArgs ids 指定为其触发事件的批注 ID。
AnnotationRemovedEventArgs ids 指定为其触发事件的批注 ID。
AnnotationSet 批评 批评。
CheckboxContentControl isChecked 指定复选框的当前状态。
ContentControl checkboxContentControl 获取内容控件的类型为“CheckBox”时的数据。
批判 colorScheme 指定批评的配色方案。
Length 指定段落内批评的长度。
start 指定段落内批评的起始索引。
CritiqueAnnotation 接受 () 接受批评。
批判 获取插入批注时传递的批注。
range 获取批注的文本范围。
拒绝 () 拒绝批评。
"文档" getAnnotationById (ID：string) 按 ID 获取批注。
onAnnotationClicked 当用户单击批注 (或使用 Alt+Down) 进行选择时发生。
onAnnotationHovered 当用户将光标悬停在批注上时发生。
onAnnotationInserted 当用户添加一个或多个注释时发生。
onAnnotationRemoved 当用户删除一个或多个批注时发生。
search (searchText： string， searchOptions？： Word。SearchOptions |{ ignorePunct？： boolean ignoreSpace？： boolean matchCase？： boolean matchPrefix？： boolean matchSuffix？： boolean matchWholeWord？： boolean matchWildcards？： boolean }) 对整个文档的范围使用指定的搜索选项执行搜索。
GetTextOptions includeHiddenText 指定一个值，该值指示是否在 GetText 方法的结果中包含隐藏文本。
includeTextMarkedAsDeleted 指定一个值，该值指示是否在 GetText 方法的结果中包含标记为已删除的文本。
InsertFileOptions importDifferentOddEvenPages 表示是否从源文档导入页眉和页脚的不同奇数页和偶数页设置。
Paragraph getAnnotations () 获取在此 Paragraph 对象上设置的注释。
getText (选项？：Word。GetTextOptions |{ IncludeHiddenText？： boolean IncludeTextMarkedAsDeleted？： boolean }) 返回段落的文本。
insertAnnotations (批注：Word。AnnotationSet) 在此 Paragraph 对象上插入批注。

另请参阅