API usage文本文档 APIApiDocument本页总览ApiDocumentAsk a question ApiDocument 是 ApiDocumentContent 的子类。 方法 方法返回值描述AcceptAllRevisionChangesboolean接受在审阅模式下所做的所有更改。AddCheckBoxContentControlApiInlineLvlSdt向文档添加新的复选框内容控件。AddComboBoxContentControlApiInlineLvlSdt向文档添加新的组合框内容控件。AddCommentApiComment向当前文档选区添加批注,如果未选择文本,则向当前单词添加批注。AddDatePickerContentControlApiInlineLvlSdt向文档添加新的日期选择器内容控件。AddDrawingToPageboolean向指定页面添加绘图。AddDropDownListContentControlApiInlineLvlSdt向文档添加新的下拉列表内容控件。AddElementboolean使用在文档内容中的位置添加段落、表格或块级内容控件。AddEndnoteApiDocumentContent为选定文本添加尾注(如果没有选区,则为当前位置添加)。AddFootnoteApiDocumentContent为选定文本添加脚注(如果没有选区,则为当前位置添加)。AddMathEquationboolean向当前文档添加数学公式。AddParagraphApiParagraph创建新段落并将其追加到文档内容的末尾。AddPictureContentControlApiInlineLvlSdt向文档添加新的图片内容控件。AddTableOfContentsboolean向当前文档添加目录。AddTableOfFiguresboolean向当前文档添加图表目录。AddTextApiRun将指定文本追加到文档内容的末尾。ClearAllFieldsboolean清除文档中的所有表单。CreateNewHistoryPointboolean创建新的历史记录点。CreateNumberingApiNumbering创建具有指定类型的抽象多级编号。CreateParagraphApiParagraph创建新的空段落。CreateSectionApiSection | null创建在指定段落处结束的新文档节。允许为当前CreateStyleApiStyle使用指定的类型和名称创建新样式。如果已存在具有指定名称的样式,将返回该样式而不创建新样式。CreateTableApiTable创建具有指定行数和列数的新表格。DeleteBookmarkboolean从文档中移除书签(如果存在)。EnterTextboolean在光标位置向文档添加文本。GetAllBookmarksNamesstring[]返回当前文档中所有书签名称的数组。GetAllCaptionParagraphsApiParagraph[]从当前文档返回指定类型的所有题注段落。GetAllChartsApiChart[]从文档内容返回图表对象集合。GetAllCommentsApiComment[]返回当前文档中的所有批注。GetAllContentControlsApiBlockLvlSdt[] | ApiInlineLvlSdt[]返回文档中所有内容控件的列表。GetAllDrawingObjectsDrawing[]从文档内容返回绘图对象集合。GetAllFormsApiForm[]返回文档中所有现有表单。GetAllHeadingParagraphsApiParagraph[]从当前文档返回所有标题段落。GetAllImagesApiImage[]从文档内容返回图像对象集合。GetAllNumberedParagraphsApiParagraph[]从当前文档返回所有编号段落。GetAllOleObjectsApiOleObject[]从文档内容返回 OLE 对象集合。GetAllParagraphsApiParagraph[]从当前文档内容返回所有段落的数组。GetAllShapesApiShape[]从文档内容返回形状对象集合。GetAllStylesApiStyle[]返回当前文档的所有样式。GetAllTablesApiTable[]从当前文档内容返回所有表格的数组。GetAllTablesOnPageApiTable[]返回给定绝对页面上的表格集合。GetBookmarkApiBookmark从当前文档中按名称返回书签。GetBookmarkRangeApiRange | null返回书签范围。GetClassType"document"返回 ApiDocument 类的类型。GetCommentByIdApiComment通过 ID 从当前文档返回批注。GetCommentsReportCommentReport返回有关添加到文档的所有批注的报告。GetContentDocumentElement[]从当前 ApiDocumentContent 对象返回文档元素数组。GetContentControlsByTagApiBlockLvlSdt[] | ApiInlineLvlSdt[]返回文档中具有指定标签名称的所有内容控件的列表。GetControlsHighlightApiColor | null返回当前文档中内容控件的高亮颜色。GetCoreApiCore检索当前文档的核心属性接口。GetCurrentContentControlApiBlockLvlSdt | ApiInlineLvlSdt | null返回当前选中的内容控件。GetCurrentFootEndnoteApiDocumentContent如果光标当前在脚注或尾注内,则返回脚注或尾注内容,否则返回 null。GetCurrentPagenumber返回当前页面的索引。GetCurrentParagraphApiParagraph返回光标所在的当前段落。GetCurrentRunApiRun返回光标所在的当前文本域。GetCurrentSentencestring返回当前句子或当前句子的一部分。GetCurrentVisiblePagesnumber[]返回当前可见页面的索引。GetCurrentWordstring返回当前单词或当前单词的一部分。GetCustomPropertiesApiCustomProperties从文档检索自定义属性。GetCustomXmlPartsApiCustomXmlParts | null检索与文档关联的自定义 XML 管理器。GetDefaultParaPrApiParaPr返回当前文档中的默认段落属性集。GetDefaultStyleApiStyle返回指定文档元素的默认样式参数。GetDefaultTextPrApiTextPr返回当前文档中文本域的默认属性集。GetDocumentInfoobject返回文档信息:GetDocumentVisitorApiDocumentVisitor返回用于遍历当前文档元素的访问器对象。GetDrawingsByNameApiDrawing[]返回按名称筛选的文档绘图对象集合。GetElementDocumentElement通过元素在文档中的位置返回元素。GetElementsCountnumber返回当前文档中的元素数量。GetEndNotesFirstParagraphsApiParagraph[]返回当前文档中所有尾注的第一个段落。GetFinalSectionApiSection返回文档的最后一节。GetFootnotesFirstParagraphsApiParagraph[]返回当前文档中所有脚注的第一个段落。GetFormKeysByRolestring[]返回附加到指定角色的所有表单键的列表。GetFormValueByKeynull | boolean | string返回指定键的表单值。对于一组单选按钮,返回 Choice,即所选项目的名称。GetFormsByKeyApiForm[]返回文档中具有指定键的所有表单的列表。GetFormsByRoleApiForm[]返回文档中具有指定角色名称的所有表单的列表。GetFormsByTagApiForm[]返回文档中具有指定标签名称的所有表单的列表。GetFormsDataFormData[]返回当前文档中所有表单的数据。GetFormsHighlightApiColor | null返回文档中表单的高亮颜色。GetInternalIdstring返回当前文档内容的内部 ID。GetPageCountnumber返回当前文档的页数。GetRangeApiRange返回表示指定文档中包含的文档部分的 Range 对象。GetRangeBySelectApiRange | null通过当前选区返回范围对象。GetReviewReportReviewReport返回有关在审阅模式下对文档所做的每个更改的报告。GetSectionsApiSection[]返回文档中的节对象集合。GetSelectedDrawingsDrawing[]返回当前文档中所有选中的绘图。GetStatisticsobject返回以对象形式表示的文档统计信息,包含以下参数:GetStyleApiStyle | null按名称返回样式。GetTagsOfAllContentControlsString[]返回文档中所有内容控件使用的所有标签的列表。GetTagsOfAllFormsString[]返回文档中所有表单使用的所有标签的列表。GetTextstring返回当前文档内容对象的内部文本。GetWatermarkSettingsApiWatermarkSettings返回当前文档中的水印设置。GoToPageboolean将光标移动到文档中指定页面的开头。GroupDrawingsApiGroup在当前文档中将绘图数组分组。InsertBlankPageboolean在当前位置插入空白页。InsertContentboolean将元素数组插入到文档的当前位置。InsertParagraphBreakboolean在光标位置向文档添加段落。InsertWatermarkboolean在每个文档页面上插入水印。IsEndnoteboolean检查当前文档内容是否为尾注。IsFootnoteboolean检查当前文档内容是否为脚注。IsTrackRevisionsboolean检查是否启用了修订跟踪模式。LastDocumentElement返回最后一个文档元素。MoveCursorDownboolean向下移动光标。MoveCursorLeftboolean向左移动光标。MoveCursorRightboolean向右移动光标。MoveCursorToEndboolean将光标移动到文档末尾。MoveCursorToNoteReferenceboolean将光标移动到主文档中此脚注/尾注的引用处。如果此文档内容不是脚注/尾注,则不执行任何操作。MoveCursorToPosboolean将光标移动到当前文档的指定位置。MoveCursorToStartboolean将光标移动到文档开头。MoveCursorUpboolean向上移动光标。Pushboolean推送段落或表格以将其实际添加到文档中。RejectAllRevisionChangesboolean拒绝在审阅模式下所做的所有更改。RemoveAllElementsboolean从当前文档或当前文档元素中移除所有元素。RemoveElementboolean使用指定的位置移除元素。RemoveSelectionboolean移除当前选区。RemoveWatermarkboolean从当前文档移除水印。ReplaceCurrentImageboolean用指定的图像替换当前图像。ReplaceCurrentSentenceboolean用指定的文本替换当前句子或当前句子的一部分。ReplaceCurrentWordboolean用指定的文本替换当前单词或当前单词的一部分。ReplaceDrawingboolean用新绘图替换绘图。SearchApiRange[]搜索文档对象的范围。搜索结果是 ApiRange 对象的集合。SearchAndReplaceboolean查找并替换文本。SelectCurrentWordobject如果可能,选择当前单词。SelectNoteReferenceboolean选择此脚注/尾注的引用。如果此文档内容不是脚注/尾注,则不执行任何操作。SetAssistantTrackRevisionsboolean在文档中启用或禁用 AI 辅助修订跟踪。SetControlsHighlightboolean为当前文档中的内容控件设置突出显示。SetEvenAndOddHdrFtrboolean指定此文档中的节是否对奇偶SetFormsDataboolean将数据设置到指定的表单。SetFormsHighlightboolean为文档中的表单设置突出显示。SetTextApiRun用指定的文本替换当前文档内容对象的所有内容,SetTrackRevisionsboolean设置修订跟踪模式。SetWatermarkSettingsApiDrawing设置当前文档中的水印设置。ShowCommentboolean通过 ID 显示批注。ToHtmlstring将文档转换为 HTML。ToJSONJSON将 ApiDocument 对象转换为 JSON 对象。ToMarkdownstring将文档转换为 Markdown。UpdateAllFieldsboolean更新文档中的所有域。UpdateAllTOCboolean更新当前文档中的所有目录。UpdateAllTOFboolean更新当前文档中的所有图表目录。