word package
类
接口
Word.AnnotationClickedEventArgs |
保存在批注插入事件上传递回的批注信息。 |
Word.AnnotationHoveredEventArgs |
保存在批注悬停事件上传递回的批注信息。 |
Word.AnnotationInsertedEventArgs |
保存在批注添加事件上传递回的批注信息。 |
Word.AnnotationPopupActionEventArgs |
表示在批注弹出操作事件上传递回的操作信息。 |
Word.AnnotationRemovedEventArgs |
保存在批注删除事件上传递回的批注信息。 |
Word.AnnotationSet |
加载项生成的批注集。 目前仅支持批评。 |
Word.CommentDetail |
此注释的 ID 和答复 ID 的结构。 |
Word.CommentEventArgs |
提供有关引发注释事件的注释的信息。 |
Word.ContentControlAddedEventArgs |
提供有关引发 contentControlAdded 事件的内容控件的信息。 |
Word.ContentControlDataChangedEventArgs |
提供有关引发 contentControlDataChanged 事件的内容控件的信息。 |
Word.ContentControlDeletedEventArgs |
提供有关引发 contentControlDeleted 事件的内容控件的信息。 |
Word.ContentControlEnteredEventArgs |
提供有关引发 contentControlEntered 事件的内容控件的信息。 |
Word.ContentControlExitedEventArgs |
提供有关引发 contentControlExited 事件的内容控件的信息。 |
Word.ContentControlOptions |
指定定义返回哪些内容控件的选项。 |
Word.ContentControlSelectionChangedEventArgs |
提供有关引发 contentControlSelectionChanged 事件的内容控件的信息。 |
Word.Critique |
将为文档中段落的指定部分呈现为下划线的批评。 |
Word.CritiquePopupOptions |
定义给定批评的弹出菜单行为的属性。 |
Word.DocumentCompareOptions |
指定要包含在比较文档操作中的选项。 |
Word.GetTextOptions |
指定要包含在 getText 操作中的选项。 |
Word.InsertFileOptions |
指定用于确定插入文件时要复制的内容的选项。 |
Word.Interfaces.AnnotationCollectionData |
一个接口,用于描述通过调用 |
Word.Interfaces.AnnotationCollectionLoadOptions |
包含 Word.Annotation 对象的集合。 |
Word.Interfaces.AnnotationCollectionUpdateData |
用于更新对象上的 |
Word.Interfaces.AnnotationData |
一个接口,用于描述通过调用 |
Word.Interfaces.AnnotationLoadOptions |
表示附加到段落的批注。 |
Word.Interfaces.BodyData |
一个接口,用于描述通过调用 |
Word.Interfaces.BodyLoadOptions |
表示文档或节的正文。 |
Word.Interfaces.BodyUpdateData |
用于更新对象上的 |
Word.Interfaces.BorderCollectionData |
一个接口,用于描述通过调用 |
Word.Interfaces.BorderCollectionLoadOptions |
表示边框样式的集合。 |
Word.Interfaces.BorderCollectionUpdateData |
用于更新对象上的 |
Word.Interfaces.BorderData |
一个接口,用于描述通过调用 |
Word.Interfaces.BorderLoadOptions |
表示文本、段落或表格的 Border 对象。 |
Word.Interfaces.BorderUpdateData |
用于更新对象上的 |
Word.Interfaces.CheckboxContentControlData |
一个接口,用于描述通过调用 |
Word.Interfaces.CheckboxContentControlLoadOptions |
特定于类型为 CheckBox 的内容控件的数据。 |
Word.Interfaces.CheckboxContentControlUpdateData |
用于更新对象上的 |
Word.Interfaces.CollectionLoadOptions |
提供仅加载集合的一部分成员的属性的方法。 |
Word.Interfaces.ComboBoxContentControlData |
一个接口,用于描述通过调用 |
Word.Interfaces.CommentCollectionData |
一个接口,用于描述通过调用 |
Word.Interfaces.CommentCollectionLoadOptions |
包含 Word.Comment 对象的集合。 |
Word.Interfaces.CommentCollectionUpdateData |
用于更新对象上的 |
Word.Interfaces.CommentContentRangeData |
一个接口,用于描述通过调用 |
Word.Interfaces.CommentContentRangeLoadOptions | |
Word.Interfaces.CommentContentRangeUpdateData |
用于更新对象上的 |
Word.Interfaces.CommentData |
一个接口,用于描述通过调用 |
Word.Interfaces.CommentLoadOptions |
表示文档中的注释。 |
Word.Interfaces.CommentReplyCollectionData |
一个接口,用于描述通过调用 |
Word.Interfaces.CommentReplyCollectionLoadOptions |
包含 Word.CommentReply 对象的集合。 表示一个批注线程中的所有批注答复。 |
Word.Interfaces.CommentReplyCollectionUpdateData |
用于更新对象上的 |
Word.Interfaces.CommentReplyData |
一个接口,用于描述通过调用 |
Word.Interfaces.CommentReplyLoadOptions |
表示文档中的批注答复。 |
Word.Interfaces.CommentReplyUpdateData |
用于更新对象上的 |
Word.Interfaces.CommentUpdateData |
用于更新对象上的 |
Word.Interfaces.ContentControlCollectionData |
一个接口,用于描述通过调用 |
Word.Interfaces.ContentControlCollectionLoadOptions |
包含 Word.ContentControl 对象的集合。 内容控件是文档中绑定的、有可能添加标签的区域,它们充当特定类型的内容的容器。 各个内容控件可能包含诸如图像、表格或格式化文本段落等内容。 目前,仅支持格式文本和纯文本内容控件。 |
Word.Interfaces.ContentControlCollectionUpdateData |
用于更新对象上的 |
Word.Interfaces.ContentControlData |
一个接口,用于描述通过调用 |
Word.Interfaces.ContentControlListItemCollectionData |
一个接口,用于描述通过调用 |
Word.Interfaces.ContentControlListItemCollectionLoadOptions |
包含 Word.ContentControlListItem 对象的集合,这些对象代表下拉列表或组合框内容控件中的项目。 |
Word.Interfaces.ContentControlListItemCollectionUpdateData |
用于更新对象上的 |
Word.Interfaces.ContentControlListItemData |
一个接口,用于描述通过调用 |
Word.Interfaces.ContentControlListItemLoadOptions |
表示下拉列表或组合框内容控件中的列表项。 |
Word.Interfaces.ContentControlListItemUpdateData |
用于更新对象上的 |
Word.Interfaces.ContentControlLoadOptions |
表示内容控件。 内容控件是文档中绑定的、有可能添加标签的区域,它们充当特定类型的内容的容器。 各个内容控件可能包含诸如图像、表格或格式化文本段落等内容。 目前,仅支持格式文本、纯文本和复选框内容控件。 |
Word.Interfaces.ContentControlUpdateData |
用于更新对象上的 |
Word.Interfaces.CritiqueAnnotationData |
一个接口,用于描述通过调用 |
Word.Interfaces.CritiqueAnnotationLoadOptions |
表示文档中显示的批注包装。 |
Word.Interfaces.CustomPropertyCollectionData |
一个接口,用于描述通过调用 |
Word.Interfaces.CustomPropertyCollectionLoadOptions |
包含 Word.CustomProperty 对象的集合。 |
Word.Interfaces.CustomPropertyCollectionUpdateData |
用于更新对象上的 |
Word.Interfaces.CustomPropertyData |
一个接口,用于描述通过调用 |
Word.Interfaces.CustomPropertyLoadOptions |
表示自定义属性。 |
Word.Interfaces.CustomPropertyUpdateData |
用于更新对象上的 |
Word.Interfaces.CustomXmlPartCollectionData |
一个接口,用于描述通过调用 |
Word.Interfaces.CustomXmlPartCollectionLoadOptions |
包含 Word.CustomXmlPart 对象的集合。 |
Word.Interfaces.CustomXmlPartCollectionUpdateData |
用于更新对象上的 |
Word.Interfaces.CustomXmlPartData |
一个接口,用于描述通过调用 |
Word.Interfaces.CustomXmlPartLoadOptions |
表示自定义 XML 部件。 |
Word.Interfaces.CustomXmlPartScopedCollectionData |
一个接口,用于描述通过调用 |
Word.Interfaces.CustomXmlPartScopedCollectionLoadOptions |
包含具有特定命名空间的 Word.CustomXmlPart 对象的集合。 |
Word.Interfaces.CustomXmlPartScopedCollectionUpdateData |
用于更新对象上的 |
Word.Interfaces.DocumentCreatedData |
一个接口,用于描述通过调用 |
Word.Interfaces.DocumentCreatedLoadOptions |
DocumentCreated 对象是由 Application.CreateDocument 创建的顶级对象。 DocumentCreated 对象是一个特殊的 Document 对象。 |
Word.Interfaces.DocumentCreatedUpdateData |
用于更新对象上的 |
Word.Interfaces.DocumentData |
一个接口,用于描述通过调用 |
Word.Interfaces.DocumentLoadOptions |
Document 对象是顶层对象。 Document 对象包含一个或多个节、内容控件以及包含文档内容的正文。 |
Word.Interfaces.DocumentPropertiesData |
一个接口,用于描述通过调用 |
Word.Interfaces.DocumentPropertiesLoadOptions |
表示文档属性。 |
Word.Interfaces.DocumentPropertiesUpdateData |
用于更新对象上的 |
Word.Interfaces.DocumentUpdateData |
用于更新对象上的 |
Word.Interfaces.DropDownListContentControlData |
一个接口,用于描述通过调用 |
Word.Interfaces.FieldCollectionData |
一个接口,用于描述通过调用 |
Word.Interfaces.FieldCollectionLoadOptions |
包含 Word.Field 对象的集合。 |
Word.Interfaces.FieldCollectionUpdateData |
用于更新对象上的 |
Word.Interfaces.FieldData |
一个接口,用于描述通过调用 |
Word.Interfaces.FieldLoadOptions |
表示一个字段。 |
Word.Interfaces.FieldUpdateData |
用于更新对象上的 |
Word.Interfaces.FontData |
一个接口,用于描述通过调用 |
Word.Interfaces.FontLoadOptions |
表示字体。 |
Word.Interfaces.FontUpdateData |
用于更新对象上的 |
Word.Interfaces.InlinePictureCollectionData |
一个接口,用于描述通过调用 |
Word.Interfaces.InlinePictureCollectionLoadOptions |
包含 Word.InlinePicture 对象的集合。 |
Word.Interfaces.InlinePictureCollectionUpdateData |
用于更新对象上的 |
Word.Interfaces.InlinePictureData |
一个接口,用于描述通过调用 |
Word.Interfaces.InlinePictureLoadOptions |
表示嵌入式图片。 |
Word.Interfaces.InlinePictureUpdateData |
用于更新对象上的 |
Word.Interfaces.ListCollectionData |
一个接口,用于描述通过调用 |
Word.Interfaces.ListCollectionLoadOptions |
包含 Word.List 对象的集合。 |
Word.Interfaces.ListCollectionUpdateData |
用于更新对象上的 |
Word.Interfaces.ListData |
一个接口,用于描述通过调用 |
Word.Interfaces.ListItemData |
一个接口,用于描述通过调用 |
Word.Interfaces.ListItemLoadOptions |
表示段落列表项格式。 |
Word.Interfaces.ListItemUpdateData |
用于更新对象上的 |
Word.Interfaces.ListLevelCollectionData |
一个接口,用于描述通过调用 |
Word.Interfaces.ListLevelCollectionLoadOptions |
包含 Word.ListLevel 对象的集合。 |
Word.Interfaces.ListLevelCollectionUpdateData |
用于更新对象上的 |
Word.Interfaces.ListLevelData |
一个接口,用于描述通过调用 |
Word.Interfaces.ListLevelLoadOptions |
表示列表级别。 |
Word.Interfaces.ListLevelUpdateData |
用于更新对象上的 |
Word.Interfaces.ListLoadOptions |
包含 Word.Paragraph 对象的集合。 |
Word.Interfaces.ListTemplateData |
一个接口,用于描述通过调用 |
Word.Interfaces.ListTemplateLoadOptions |
表示 ListTemplate。 |
Word.Interfaces.ListTemplateUpdateData |
用于更新对象上的 |
Word.Interfaces.NoteItemCollectionData |
一个接口,用于描述通过调用 |
Word.Interfaces.NoteItemCollectionLoadOptions |
包含 Word.NoteItem 对象的集合。 |
Word.Interfaces.NoteItemCollectionUpdateData |
用于更新对象上的 |
Word.Interfaces.NoteItemData |
一个接口,用于描述通过调用 |
Word.Interfaces.NoteItemLoadOptions |
表示脚注或尾注。 |
Word.Interfaces.NoteItemUpdateData |
用于更新对象上的 |
Word.Interfaces.ParagraphCollectionData |
一个接口,用于描述通过调用 |
Word.Interfaces.ParagraphCollectionLoadOptions |
包含 Word.Paragraph 对象的集合。 |
Word.Interfaces.ParagraphCollectionUpdateData |
用于更新对象上的 |
Word.Interfaces.ParagraphData |
一个接口,用于描述通过调用 |
Word.Interfaces.ParagraphFormatData |
一个接口,用于描述通过调用 |
Word.Interfaces.ParagraphFormatLoadOptions |
表示文档中段落的样式。 |
Word.Interfaces.ParagraphFormatUpdateData |
用于更新对象上的 |
Word.Interfaces.ParagraphLoadOptions |
表示选定内容、区域、内容控件或文档正文中的单个段落。 |
Word.Interfaces.ParagraphUpdateData |
用于更新对象上的 |
Word.Interfaces.RangeCollectionData |
一个接口,用于描述通过调用 |
Word.Interfaces.RangeCollectionLoadOptions |
包含 Word.Range 对象的集合。 |
Word.Interfaces.RangeCollectionUpdateData |
用于更新对象上的 |
Word.Interfaces.RangeData |
一个接口,用于描述通过调用 |
Word.Interfaces.RangeLoadOptions |
表示文档中的一个连续区域。 |
Word.Interfaces.RangeUpdateData |
用于更新对象上的 |
Word.Interfaces.SearchOptionsData |
一个接口,用于描述通过调用 |
Word.Interfaces.SearchOptionsLoadOptions |
指定要包括在搜索操作中的选项。 若要详细了解如何在 Word JavaScript API 中使用搜索选项,请阅读 使用搜索选项在 Word 加载项中查找文本。 |
Word.Interfaces.SearchOptionsUpdateData |
用于更新对象上的 |
Word.Interfaces.SectionCollectionData |
一个接口,用于描述通过调用 |
Word.Interfaces.SectionCollectionLoadOptions |
包含文档的 Word.Section 对象的集合。 |
Word.Interfaces.SectionCollectionUpdateData |
用于更新对象上的 |
Word.Interfaces.SectionData |
一个接口,用于描述通过调用 |
Word.Interfaces.SectionLoadOptions |
表示 Word 文档中的一节。 |
Word.Interfaces.SectionUpdateData |
用于更新对象上的 |
Word.Interfaces.SettingCollectionData |
一个接口,用于描述通过调用 |
Word.Interfaces.SettingCollectionLoadOptions |
包含 Word.Setting 对象的集合。 |
Word.Interfaces.SettingCollectionUpdateData |
用于更新对象上的 |
Word.Interfaces.SettingData |
一个接口,用于描述通过调用 |
Word.Interfaces.SettingLoadOptions |
表示加载项的设置。 |
Word.Interfaces.SettingUpdateData |
用于更新对象上的 |
Word.Interfaces.ShadingData |
一个接口,用于描述通过调用 |
Word.Interfaces.ShadingLoadOptions |
表示底纹对象。 |
Word.Interfaces.ShadingUpdateData |
用于更新对象上的 |
Word.Interfaces.StyleCollectionData |
一个接口,用于描述通过调用 |
Word.Interfaces.StyleCollectionLoadOptions |
包含 Word.Style 对象的集合。 |
Word.Interfaces.StyleCollectionUpdateData |
用于更新对象上的 |
Word.Interfaces.StyleData |
一个接口,用于描述通过调用 |
Word.Interfaces.StyleLoadOptions |
表示 Word 文档中的样式。 |
Word.Interfaces.StyleUpdateData |
用于更新对象上的 |
Word.Interfaces.TableBorderData |
一个接口,用于描述通过调用 |
Word.Interfaces.TableBorderLoadOptions |
指定边框样式。 |
Word.Interfaces.TableBorderUpdateData |
用于更新对象上的 |
Word.Interfaces.TableCellCollectionData |
一个接口,用于描述通过调用 |
Word.Interfaces.TableCellCollectionLoadOptions |
包含文档的 TableCell 对象的集合。 |
Word.Interfaces.TableCellCollectionUpdateData |
用于更新对象上的 |
Word.Interfaces.TableCellData |
一个接口,用于描述通过调用 |
Word.Interfaces.TableCellLoadOptions |
表示 Word 文档中的表格单元格。 |
Word.Interfaces.TableCellUpdateData |
用于更新对象上的 |
Word.Interfaces.TableCollectionData |
一个接口,用于描述通过调用 |
Word.Interfaces.TableCollectionLoadOptions |
包含文档的 Table 对象的集合。 |
Word.Interfaces.TableCollectionUpdateData |
用于更新对象上的 |
Word.Interfaces.TableData |
一个接口,用于描述通过调用 |
Word.Interfaces.TableLoadOptions |
表示 Word 文档中的表。 |
Word.Interfaces.TableRowCollectionData |
一个接口,用于描述通过调用 |
Word.Interfaces.TableRowCollectionLoadOptions |
包含文档的 TableRow 对象的集合。 |
Word.Interfaces.TableRowCollectionUpdateData |
用于更新对象上的 |
Word.Interfaces.TableRowData |
一个接口,用于描述通过调用 |
Word.Interfaces.TableRowLoadOptions |
表示 Word 文档中的一行。 |
Word.Interfaces.TableRowUpdateData |
用于更新对象上的 |
Word.Interfaces.TableStyleData |
一个接口,用于描述通过调用 |
Word.Interfaces.TableStyleLoadOptions |
表示 TableStyle 对象。 |
Word.Interfaces.TableStyleUpdateData |
用于更新对象上的 |
Word.Interfaces.TableUpdateData |
用于更新对象上的 |
Word.Interfaces.TrackedChangeCollectionData |
一个接口,用于描述通过调用 |
Word.Interfaces.TrackedChangeCollectionLoadOptions |
包含 Word.TrackedChange 对象的集合。 |
Word.Interfaces.TrackedChangeCollectionUpdateData |
用于更新对象上的 |
Word.Interfaces.TrackedChangeData |
一个接口,用于描述通过调用 |
Word.Interfaces.TrackedChangeLoadOptions |
表示 Word 文档中的修订。 |
Word.ParagraphAddedEventArgs |
提供有关引发 paragraphAdded 事件的段落的信息。 |
Word.ParagraphChangedEventArgs |
提供有关引发 paragraphChanged 事件的段落的信息。 |
Word.ParagraphDeletedEventArgs |
提供有关引发 paragraphDeleted 事件的段落的信息。 |
枚举
函数
Word. |
使用以前创建的 API 对象的 RequestContext 执行对 Word 对象模型执行操作的批处理脚本。 |
Word. |
使用以前创建的 API 对象的 RequestContext 执行对 Word 对象模型执行操作的批处理脚本。 承诺解决后,将释放在执行过程中自动分配的任何跟踪对象。 |
Word. |
使用新的 RequestContext 执行对 Word 对象模型执行操作的批处理脚本。 承诺解决后,将释放在执行过程中自动分配的任何跟踪对象。 |
函数详细信息
Word.run(objects, batch)
使用以前创建的 API 对象的 RequestContext 执行对 Word 对象模型执行操作的批处理脚本。
export function run<T>(objects: OfficeExtension.ClientObject[], batch: (context: Word.RequestContext) => Promise<T>): Promise<T>;
参数
- objects
以前创建的 API 对象的数组。 将对数组进行验证,以确保所有对象共享相同的上下文。 批处理将使用此共享的 RequestContext,这意味着“context.sync () ”将选取应用于这些对象的任何更改。
- batch
-
(context: Word.RequestContext) => Promise<T>
一个函数,它接受 RequestContext 并返回承诺 (通常只是“context.sync () ”) 的结果。 上下文参数有助于向 Word 应用程序发出请求。 由于 Office 加载项和 Word 应用程序在两个不同的进程中运行,因此需要 RequestContext 才能从外接程序访问 Word 对象模型。
返回
Promise<T>
Word.run(object, batch)
使用以前创建的 API 对象的 RequestContext 执行对 Word 对象模型执行操作的批处理脚本。 承诺解决后,将释放在执行过程中自动分配的任何跟踪对象。
export function run<T>(object: OfficeExtension.ClientObject, batch: (context: Word.RequestContext) => Promise<T>): Promise<T>;
参数
- object
- OfficeExtension.ClientObject
以前创建的 API 对象。 批处理将使用与传入对象相同的 RequestContext,这意味着“context.sync () ”将选取应用于该对象的任何更改。
- batch
-
(context: Word.RequestContext) => Promise<T>
一个函数,它接受 RequestContext 并返回承诺 (通常只是“context.sync () ”) 的结果。 上下文参数有助于向 Word 应用程序发出请求。 由于 Office 加载项和 Word 应用程序在两个不同的进程中运行,因此需要 RequestContext 才能从外接程序访问 Word 对象模型。
返回
Promise<T>
Word.run(batch)
使用新的 RequestContext 执行对 Word 对象模型执行操作的批处理脚本。 承诺解决后,将释放在执行过程中自动分配的任何跟踪对象。
export function run<T>(batch: (context: Word.RequestContext) => Promise<T>): Promise<T>;
参数
- batch
-
(context: Word.RequestContext) => Promise<T>
一个函数,它接受 RequestContext 并返回承诺 (通常只是“context.sync () ”) 的结果。 上下文参数有助于向 Word 应用程序发出请求。 由于 Office 加载项和 Word 应用程序在两个不同的进程中运行,因此需要 RequestContext 才能从外接程序访问 Word 对象模型。
返回
Promise<T>