ApiDocument

表示 ApiDocument 类。

方法

方法	返回值	描述
AcceptAllRevisionChanges	boolean	接受在审阅模式下所做的所有更改。
AddCheckBoxContentControl	ApiInlineLvlSdt	向文档添加新的复选框内容控件。
AddComboBoxContentControl	ApiInlineLvlSdt	向文档添加新的组合框内容控件。
AddComment	ApiComment	向当前文档选区添加批注，如果未选择文本，则向当前单词添加批注。
AddDatePickerContentControl	ApiInlineLvlSdt	向文档添加新的日期选择器内容控件。
AddDrawingToPage	boolean	向指定页面添加绘图。💡 此方法可能会有点慢，因为它会运行文档计算过程来排列指定页面上的表格。
AddDropDownListContentControl	ApiInlineLvlSdt	向文档添加新的下拉列表内容控件。
AddElement	boolean	使用在文档内容中的位置添加段落、表格或块级内容控件。
AddEndnote	ApiDocumentContent	为选定文本添加尾注（如果没有选区，则为当前位置添加）。
AddFootnote	ApiDocumentContent	为选定文本添加脚注（如果没有选区，则为当前位置添加）。
AddMathEquation	boolean	向当前文档添加数学公式。
AddPictureContentControl	ApiInlineLvlSdt	向文档添加新的图片内容控件。
AddTableOfContents	boolean	向当前文档添加目录。💡 请注意，新目录会替换现有目录。
AddTableOfFigures	boolean	向当前文档添加图表目录。
ClearAllFields	boolean	清除文档中的所有表单。
CreateNewHistoryPoint	boolean	创建新的历史记录点。
CreateNumbering	ApiNumbering	创建具有指定类型的抽象多级编号。
CreateSection	ApiSection | null	创建在指定段落处结束的新文档节。允许为当前节设置局部参数 - 页面大小、页脚、页眉、分栏等。
CreateStyle	ApiStyle	创建具有指定类型和名称的新样式。如果存在同名样式，它将被新样式替换。
DeleteBookmark	boolean	从文档中移除书签（如果存在）。
EnterText	boolean	在光标位置向文档添加文本。
GetAllBookmarksNames	string[]	返回当前文档中所有书签名称的数组。
GetAllCaptionParagraphs	ApiParagraph[]	从当前文档返回指定类型的所有题注段落。
GetAllCharts	ApiChart[]	从文档内容返回图表对象集合。
GetAllComments	ApiComment[]	返回当前文档中的所有批注。
GetAllContentControls	ApiBlockLvlSdt[] | ApiInlineLvlSdt[]	返回文档中所有内容控件的列表。
GetAllDrawingObjects	Drawing[]	从文档内容返回绘图对象集合。
GetAllForms	ApiForm[]	返回文档中所有现有表单。
GetAllHeadingParagraphs	ApiParagraph[]	从当前文档返回所有标题段落。
GetAllImages	ApiImage[]	从文档内容返回图像对象集合。
GetAllNumberedParagraphs	ApiParagraph[]	从当前文档返回所有编号段落。
GetAllOleObjects	ApiOleObject[]	从文档内容返回 OLE 对象集合。
GetAllParagraphs	ApiParagraph[]	从当前文档内容返回所有段落的数组。
GetAllShapes	ApiShape[]	从文档内容返回形状对象集合。
GetAllStyles	ApiStyle[]	返回当前文档的所有样式。
GetAllTables	ApiTable[]	从当前文档内容返回所有表格的数组。
GetAllTablesOnPage	ApiTable[]	返回给定绝对页面上的表格集合。💡 此方法可能会有点慢，因为它会运行文档计算过程来排列指定页面上的表格。
GetBookmark	ApiBookmark	从当前文档中按名称返回书签。
GetBookmarkRange	ApiRange | null	返回书签范围。
GetClassType	"document"	返回 ApiDocument 类的类型。
GetCommentById	ApiComment	通过 ID 从当前文档返回批注。
GetCommentsReport	CommentReport	返回有关添加到文档的所有批注的报告。
GetContent	DocumentElement[]	从当前 ApiDocumentContent 对象返回文档元素数组。
GetContentControlsByTag	ApiBlockLvlSdt[] | ApiInlineLvlSdt[]	返回文档中具有指定标签名称的所有内容控件的列表。
GetCore	ApiCore	检索当前文档的核心属性接口。此方法用于查看或修改标准元数据，如标题、作者和关键字。
GetCurrentContentControl	ApiBlockLvlSdt | ApiInlineLvlSdt | null	返回当前选中的内容控件。
GetCurrentFootEndnote	ApiDocumentContent	如果光标当前在脚注或尾注内，则返回脚注或尾注内容，否则返回 null。
GetCurrentPage	number	返回当前页面的索引。
GetCurrentParagraph	ApiParagraph	返回光标所在的当前段落。
GetCurrentRun	ApiRun	返回光标所在的当前文本域。
GetCurrentSentence	string	返回当前句子或当前句子的一部分。
GetCurrentVisiblePages	number[]	返回当前可见页面的索引。
GetCurrentWord	string	返回当前单词或当前单词的一部分。
GetCustomProperties	ApiCustomProperties	从文档检索自定义属性。
GetCustomXmlParts	ApiCustomXmlParts | null	检索与文档关联的自定义 XML 管理器。此管理器允许操作和访问文档内的自定义 XML 部分。
GetDefaultParaPr	ApiParaPr	返回当前文档中的默认段落属性集。
GetDefaultStyle	ApiStyle	返回指定文档元素的默认样式参数。
GetDefaultTextPr	ApiTextPr	返回当前文档中文本域的默认属性集。
GetDocumentInfo	object	返回文档信息：Application - 创建文档的应用程序。CreatedRaw - 文件创建的日期和时间。Created - 解析后的文件创建日期和时间。LastModifiedRaw - 文件最后修改的日期和时间。LastModified - 解析后的文件最后修改日期和时间。LastModifiedBy - 对文档进行最新更改的用户名称。Authors - 创建文件的人员。Title - 文档标题（此属性允许您简化文档分类）。Tags - 文档标签（此属性允许您简化文档分类）。Subject - 文档主题（此属性允许您简化文档分类）。Comment - 文档的批注（此属性允许您简化文档分类）。
GetDocumentVisitor	ApiDocumentVisitor	返回用于遍历当前文档元素的访问器对象。
GetDrawingsByName	ApiDrawing[]	返回按名称筛选的文档绘图对象集合。
GetElement	DocumentElement	通过元素在文档中的位置返回元素。
GetElementsCount	number	返回当前文档中的元素数量。
GetEndNotesFirstParagraphs	ApiParagraph[]	返回当前文档中所有尾注的第一个段落。
GetFinalSection	ApiSection	返回文档的最后一节。
GetFootnotesFirstParagraphs	ApiParagraph[]	返回当前文档中所有脚注的第一个段落。
GetFormKeysByRole	string[]	返回附加到指定角色的所有表单键的列表。
GetFormValueByKey	null | boolean | string	返回指定键的表单值。对于一组单选按钮，返回 Choice，即所选项目的名称。
GetFormsByKey	ApiForm[]	返回文档中具有指定键的所有表单的列表。
GetFormsByRole	ApiForm[]	返回文档中具有指定角色名称的所有表单的列表。
GetFormsByTag	ApiForm[]	返回文档中具有指定标签名称的所有表单的列表。
GetFormsData	FormData[]	返回当前文档中所有表单的数据。如果表单已创建但未分配到文档的任何部分，则不会出现在此列表中。
GetInternalId	string	返回当前文档内容的内部 ID。
GetPageCount	number	返回当前文档的页数。💡 对于大型文档，此方法可能会很慢，因为它会在完全重新计算之前运行文档计算过程。
GetRange	ApiRange	返回表示指定文档中包含的文档部分的 Range 对象。
GetRangeBySelect	ApiRange | null	通过当前选区返回范围对象。
GetReviewReport	ReviewReport	返回有关在审阅模式下对文档所做的每个更改的报告。
GetSections	ApiSection[]	返回文档中的节对象集合。
GetSelectedDrawings	ApiShape[] | ApiImage[] | ApiChart[] | ApiDrawing[]	返回当前文档中所有选中的绘图。
GetStatistics	object	返回以对象形式表示的文档统计信息，包含以下参数：PageCount - 页数；WordsCount - 字数；ParagraphCount - 段落数；SymbolsCount - 符号数；SymbolsWSCount - 包含空格的符号数。
GetStyle	ApiStyle	按名称返回样式。
GetTagsOfAllContentControls	String[]	返回文档中所有内容控件使用的所有标签的列表。
GetTagsOfAllForms	String[]	返回文档中所有表单使用的所有标签的列表。
GetText	string	返回当前文档内容对象的内部文本。
GetWatermarkSettings	ApiWatermarkSettings	返回当前文档中的水印设置。
GoToPage	boolean	将光标移动到文档中指定页面的开头。
GroupDrawings	ApiGroup	在当前文档中将绘图数组分组。
InsertBlankPage	boolean	在当前位置插入空白页。
InsertContent	boolean	将元素数组插入到文档的当前位置。
InsertParagraphBreak	boolean	在光标位置向文档添加段落。
InsertWatermark	boolean	在每个文档页面上插入水印。
IsEndnote	boolean	检查当前文档内容是否为尾注。
IsFootnote	boolean	检查当前文档内容是否为脚注。
IsTrackRevisions	boolean	检查是否启用了修订跟踪模式。
Last	DocumentElement	返回最后一个文档元素。
MoveCursorDown	boolean	向下移动光标。
MoveCursorLeft	boolean	向左移动光标。
MoveCursorRight	boolean	向右移动光标。
MoveCursorToEnd	boolean	将光标移动到文档末尾。
MoveCursorToPos	boolean	将光标移动到当前文档的指定位置。如果文档中有任何选区，它将被移除。
MoveCursorToStart	boolean	将光标移动到文档开头。
MoveCursorUp	boolean	向上移动光标。
Push	boolean	推送段落或表格以将其实际添加到文档中。
RejectAllRevisionChanges	boolean	拒绝在审阅模式下所做的所有更改。
RemoveAllElements	boolean	从当前文档或当前文档元素中移除所有元素。💡 当所有元素被移除时，会自动创建一个新的空段落。如果要向此段落添加内容，请使用 ApiDocumentContent#GetElement 方法。
RemoveElement	boolean	使用指定的位置移除元素。
RemoveSelection	boolean	移除当前选区。
RemoveWatermark	boolean	从当前文档移除水印。
ReplaceCurrentImage	boolean	用指定的图像替换当前图像。
ReplaceCurrentSentence	boolean	用指定的文本替换当前句子或当前句子的一部分。
ReplaceCurrentWord	boolean	用指定的文本替换当前单词或当前单词的一部分。
ReplaceDrawing	boolean	用新绘图替换绘图。
Search	ApiRange[]	搜索文档对象的范围。搜索结果是 ApiRange 对象的集合。
SearchAndReplace	boolean	查找并替换文本。
SelectCurrentWord	object	如果可能，选择当前单词。
SelectNoteReference	boolean	选择此脚注/尾注的引用。如果此文档内容不是脚注/尾注，则不执行任何操作。
SetAssistantTrackRevisions	boolean	在文档中启用或禁用 AI 辅助修订跟踪。
SetControlsHighlight	boolean	为当前文档中的内容控件设置突出显示。
SetEvenAndOddHdrFtr	boolean	指定此文档中的节是否对奇偶页使用不同的页眉和页脚（奇数页使用一个页眉/页脚，偶数页使用另一个页眉/页脚）。
SetFormsData	boolean	将数据设置到指定的表单。
SetFormsHighlight	boolean	为文档中的表单设置突出显示。
SetTrackRevisions	boolean	设置修订跟踪模式。
SetWatermarkSettings	ApiDrawing	设置当前文档中的水印设置。
ShowComment	boolean	通过 ID 显示批注。
ToHtml	string	将文档转换为 HTML。
ToJSON	JSON	将 ApiDocument 对象转换为 JSON 对象。
ToMarkdown	string	将文档转换为 Markdown。
UpdateAllFields	boolean	更新文档中的所有域。
UpdateAllTOC	boolean	更新当前文档中的所有目录。
UpdateAllTOF	boolean	更新当前文档中的所有图表目录。