此页面由 Cloud Translation API 翻译。

Document Service
使用集合让一切井井有条根据您的偏好保存内容并对其进行分类。

此服务允许脚本创建、访问和修改 Google 文档文件。

// Open a document by ID.
var doc = DocumentApp.openById('DOCUMENT_ID');

// Create and open a document.
doc = DocumentApp.create('Document Name');

类

名称	简介
`Attribute`	元素属性的枚举。
`Body`	Google 文档中标签页中的内容。
`Bookmark`	表示书签的对象。
`ContainerElement`	一个可能包含其他元素的通用元素。
`Date`	表示格式化日期的元素
`Document`	文档，其中包含一个或多个 `Tab` 对象，每个对象都包含富文本和表格和列表等元素。
`DocumentApp`	文档服务会创建并打开可编辑的 `Documents`。
`DocumentTab`	文档标签页，其中包含富文本和表格、列表等元素。
`Element`	通用元素。
`ElementType`	所有元素类型的枚举。
`Equation`	表示数学表达式的元素。
`EquationFunction`	表示数学 `Equation` 中的函数的元素。
`EquationFunctionArgumentSeparator`	表示数学 `Equation` 中的函数分隔符的元素。
`EquationSymbol`	表示数学 `Equation` 中的符号的元素。
`FontFamily`	受支持的字体的枚举。
`FooterSection`	表示页脚部分的元素。
`Footnote`	表示脚注的元素。
`FootnoteSection`	表示脚注部分的元素。
`GlyphType`	支持的字形类型的枚举。
`HeaderSection`	表示标题部分的元素。
`HorizontalAlignment`	受支持的水平对齐类型的枚举。
`HorizontalRule`	表示水平线的元素。
`InlineDrawing`	表示嵌入式绘图的元素。
`InlineImage`	表示嵌入图片的元素。
`ListItem`	表示列表项的元素。
`NamedRange`	具有名称和 ID 的 `Range`，以便日后检索。
`PageBreak`	表示分页的元素。
`Paragraph`	表示段落的元素。
`ParagraphHeading`	标准段落标题的枚举。
`Person`	表示指向人物的链接的元素。
`Position`	对文档标签页中相对于特定元素的位置的引用。
`PositionedImage`	固定位置图片锚定到 `Paragraph`。
`PositionedLayout`	一个枚举，用于指定如何将 `PositionedImage` 与周围文本一起排版。
`Range`	文档中的元素范围。
`RangeBuilder`	用于根据文档元素构建 `Range` 对象的构建器。
`RangeElement`	封装了 `Element` 的封装容器，可能具有开始偏移量和结束偏移量。
`RichLink`	表示指向 Google 资源（例如云端硬盘文件或 YouTube 视频）的链接的元素。
`Tab`	Google 文档中的标签页。
`TabType`	所有标签页类型的枚举。
`Table`	表示表格的元素。
`TableCell`	表示表格单元格的元素。
`TableOfContents`	包含目录的元素。
`TableRow`	表示表格的行。
`Text`	表示富文本区域的元素。
`TextAlignment`	文本对齐方式的枚举。
`UnsupportedElement`	表示未知或无法受脚本影响的区域的元素，例如页码。
`VerticalAlignment`	支持的垂直对齐类型的枚举。

`Attribute`

属性

属性	类型	说明
`BACKGROUND_COLOR`	`Enum`	元素（段落、表格等）或文档的背景颜色。
`BOLD`	`Enum`	富文本的字体粗细设置。
`BORDER_COLOR`	`Enum`	表格元素的边框颜色。
`BORDER_WIDTH`	`Enum`	表格元素的边框宽度（以点数为单位）。
`CODE`	`Enum`	等式元素的代码内容。
`FONT_FAMILY`	`Enum`	适用于富文本的字体系列设置。
`FONT_SIZE`	`Enum`	富文本的字体大小设置（以点为单位）。
`FOREGROUND_COLOR`	`Enum`	富文本的前景颜色设置。
`HEADING`	`Enum`	段落元素的标题类型（例如 `DocumentApp.ParagraphHeading.HEADING1`）。
`HEIGHT`	`Enum`	图片元素的高度设置。
`HORIZONTAL_ALIGNMENT`	`Enum`	段落元素（例如 `DocumentApp.HorizontalAlignment.CENTER`）的水平对齐方式。
`INDENT_END`	`Enum`	段落元素的末尾缩进设置（以点为单位）。
`INDENT_FIRST_LINE`	`Enum`	段落元素的第一行缩进设置（以点为单位）。
`INDENT_START`	`Enum`	段落元素的起始缩进设置（以点为单位）。
`ITALIC`	`Enum`	富文本的字体样式设置。
`GLYPH_TYPE`	`Enum`	用于列表项元素的字形类型。
`LEFT_TO_RIGHT`	`Enum`	富文本的文本方向设置。
`LINE_SPACING`	`Enum`	行间距设置（作为乘数），适用于段落元素。
`LINK_URL`	`Enum`	链接网址（适用于富文本）。
`LIST_ID`	`Enum`	包含列表项元素的列表的 ID。
`MARGIN_BOTTOM`	`Enum`	段落元素的下边距设置（以点为单位）。
`MARGIN_LEFT`	`Enum`	段落元素的左边距设置（以磅为单位）。
`MARGIN_RIGHT`	`Enum`	段落元素的右边距设置（以点为单位）。
`MARGIN_TOP`	`Enum`	段落元素的上边距设置（以点为单位）。
`NESTING_LEVEL`	`Enum`	列表项元素的项嵌套级别。
`MINIMUM_HEIGHT`	`Enum`	表格行元素的最小高度设置（以点为单位）。
`PADDING_BOTTOM`	`Enum`	表格单元格元素的底部内边距设置（以点为单位）。
`PADDING_LEFT`	`Enum`	表格单元格元素的左内边距设置（以点为单位）。
`PADDING_RIGHT`	`Enum`	表格单元格元素的右内边距设置（以点为单位）。
`PADDING_TOP`	`Enum`	表格单元格元素的顶部内边距设置（以点为单位）。
`PAGE_HEIGHT`	`Enum`	文档的页面高度设置（以点为单位）。
`PAGE_WIDTH`	`Enum`	文档的页面宽度设置（以磅为单位）。
`SPACING_AFTER`	`Enum`	段落元素的底部间距设置（以点为单位）。
`SPACING_BEFORE`	`Enum`	段落元素的上间距设置（以点为单位）。
`STRIKETHROUGH`	`Enum`	用于富文本的删除线设置。
`UNDERLINE`	`Enum`	下划线设置，适用于富文本。
`VERTICAL_ALIGNMENT`	`Enum`	表格单元格元素的垂直对齐设置。
`WIDTH`	`Enum`	表格单元格和图片元素的宽度设置。

`Body`

方法

方法	返回类型	简介
`appendHorizontalRule()`	`HorizontalRule`	创建并附加新的 `HorizontalRule`。
`appendImage(image)`	`InlineImage`	从指定的图片 blob 创建并附加新的 `InlineImage`。
`appendImage(image)`	`InlineImage`	附加给定的 `InlineImage`。
`appendListItem(listItem)`	`ListItem`	附加给定的 `ListItem`。
`appendListItem(text)`	`ListItem`	创建并附加包含指定文本内容的新 `ListItem`。
`appendPageBreak()`	`PageBreak`	创建并附加新的 `PageBreak`。
`appendPageBreak(pageBreak)`	`PageBreak`	附加给定的 `PageBreak`。
`appendParagraph(paragraph)`	`Paragraph`	附加给定的 `Paragraph`。
`appendParagraph(text)`	`Paragraph`	创建并附加包含指定文本内容的新 `Paragraph`。
`appendTable()`	`Table`	创建并附加新的 `Table`。
`appendTable(cells)`	`Table`	为每个指定的字符串值附加一个包含 `TableCell` 的新 `Table`。
`appendTable(table)`	`Table`	附加给定的 `Table`。
`clear()`	`Body`	清除元素的内容。
`copy()`	`Body`	返回当前元素的脱离式深层副本。
`editAsText()`	`Text`	获取当前元素的 `Text` 版本，以供修改。
`findElement(elementType)`	`RangeElement`	在元素的内容中搜索指定类型的后代。
`findElement(elementType, from)`	`RangeElement`	从指定的 `RangeElement` 开始，在元素的内容中搜索指定类型的后代。
`findText(searchPattern)`	`RangeElement`	使用正则表达式在元素内容中搜索指定的文本模式。
`findText(searchPattern, from)`	`RangeElement`	从给定搜索结果开始，在元素内容中搜索指定的文本模式。
`getAttributes()`	`Object`	检索元素的属性。
`getChild(childIndex)`	`Element`	检索指定子索引位置的子元素。
`getChildIndex(child)`	`Integer`	检索指定子元素的子元素索引。
`getHeadingAttributes(paragraphHeading)`	`Object`	检索所提供 `ParagraphHeading` 的一组属性。
`getImages()`	`InlineImage[]`	检索该部分中包含的所有 `InlineImages`。
`getListItems()`	`ListItem[]`	检索该部分中包含的所有 `ListItems`。
`getMarginBottom()`	`Number`	检索下边距（以点为单位）。
`getMarginLeft()`	`Number`	检索左边距（以点为单位）。
`getMarginRight()`	`Number`	检索右外边距。
`getMarginTop()`	`Number`	检索上外边距。
`getNumChildren()`	`Integer`	检索子项的数量。
`getPageHeight()`	`Number`	检索页面高度（以点为单位）。
`getPageWidth()`	`Number`	检索页面宽度（以点为单位）。
`getParagraphs()`	`Paragraph[]`	检索该部分中包含的所有 `Paragraphs`（包括 `ListItems`）。
`getParent()`	`ContainerElement`	检索元素的父元素。
`getTables()`	`Table[]`	检索该部分中包含的所有 `Tables`。
`getText()`	`String`	以文本字符串的形式检索元素的内容。
`getTextAlignment()`	`TextAlignment`	获取文本对齐方式。
`getType()`	`ElementType`	检索元素的 `ElementType`。
`insertHorizontalRule(childIndex)`	`HorizontalRule`	在指定索引处创建并插入新的 `HorizontalRule`。
`insertImage(childIndex, image)`	`InlineImage`	在指定位置从指定图片 blob 创建并插入 `InlineImage`。
`insertImage(childIndex, image)`	`InlineImage`	在指定的索引处插入给定的 `InlineImage`。
`insertListItem(childIndex, listItem)`	`ListItem`	在指定的索引处插入给定的 `ListItem`。
`insertListItem(childIndex, text)`	`ListItem`	在指定索引处创建并插入包含指定文本内容的新 `ListItem`。
`insertPageBreak(childIndex)`	`PageBreak`	在指定索引处创建并插入新的 `PageBreak`。
`insertPageBreak(childIndex, pageBreak)`	`PageBreak`	在指定的索引处插入给定的 `PageBreak`。
`insertParagraph(childIndex, paragraph)`	`Paragraph`	在指定的索引处插入给定的 `Paragraph`。
`insertParagraph(childIndex, text)`	`Paragraph`	在指定索引处创建并插入包含指定文本内容的新 `Paragraph`。
`insertTable(childIndex)`	`Table`	在指定索引处创建并插入新的 `Table`。
`insertTable(childIndex, cells)`	`Table`	在指定索引处创建并插入包含指定单元格的新 `Table`。
`insertTable(childIndex, table)`	`Table`	在指定的索引处插入给定的 `Table`。
`removeChild(child)`	`Body`	移除指定的子元素。
`replaceText(searchPattern, replacement)`	`Element`	使用正则表达式将给定文本模式的所有出现替换为给定的替换字符串。
`setAttributes(attributes)`	`Body`	设置元素的属性。
`setHeadingAttributes(paragraphHeading, attributes)`	`Body`	为所提供的 `ParagraphHeading` 设置属性。
`setMarginBottom(marginBottom)`	`Body`	设置下边距（以点为单位）。
`setMarginLeft(marginLeft)`	`Body`	设置左边距（以点为单位）。
`setMarginRight(marginRight)`	`Body`	设置右外边距（以点为单位）。
`setMarginTop(marginTop)`	`Body`	设置上边距。
`setPageHeight(pageHeight)`	`Body`	设置页面高度（以点为单位）。
`setPageWidth(pageWidth)`	`Body`	设置页面宽度（以点为单位）。
`setText(text)`	`Body`	将内容设置为纯文本。
`setTextAlignment(textAlignment)`	`Body`	设置文本对齐方式。

`Bookmark`

方法

方法	返回类型	简介
`getId()`	`String`	获取 `Bookmark` 的 ID。
`getPosition()`	`Position`	获取 `DocumentTab` 中的 `Bookmark` 的 `Position`。
`remove()`	`void`	删除 `Bookmark`。

`ContainerElement`

方法

方法	返回类型	简介
`asBody()`	`Body`	以 `Body` 的形式返回当前元素。
`asEquation()`	`Equation`	以 `Equation` 的形式返回当前元素。
`asFooterSection()`	`FooterSection`	以 `FooterSection` 的形式返回当前元素。
`asFootnoteSection()`	`FootnoteSection`	以 `FootnoteSection` 的形式返回当前元素。
`asHeaderSection()`	`HeaderSection`	以 `HeaderSection` 的形式返回当前元素。
`asListItem()`	`ListItem`	以 `ListItem` 的形式返回当前元素。
`asParagraph()`	`Paragraph`	以 `Paragraph` 的形式返回当前元素。
`asTable()`	`Table`	以 `Table` 的形式返回当前元素。
`asTableCell()`	`TableCell`	以 `TableCell` 的形式返回当前元素。
`asTableOfContents()`	`TableOfContents`	以 `TableOfContents` 的形式返回当前元素。
`asTableRow()`	`TableRow`	以 `TableRow` 的形式返回当前元素。
`clear()`	`ContainerElement`	清除元素的内容。
`copy()`	`ContainerElement`	返回当前元素的脱离式深层副本。
`editAsText()`	`Text`	获取当前元素的 `Text` 版本，以供修改。
`findElement(elementType)`	`RangeElement`	在元素的内容中搜索指定类型的后代。
`findElement(elementType, from)`	`RangeElement`	从指定的 `RangeElement` 开始，在元素的内容中搜索指定类型的后代。
`findText(searchPattern)`	`RangeElement`	使用正则表达式在元素内容中搜索指定的文本模式。
`findText(searchPattern, from)`	`RangeElement`	从给定搜索结果开始，在元素内容中搜索指定的文本模式。
`getAttributes()`	`Object`	检索元素的属性。
`getChild(childIndex)`	`Element`	检索指定子索引位置的子元素。
`getChildIndex(child)`	`Integer`	检索指定子元素的子元素索引。
`getLinkUrl()`	`String`	检索链接网址。
`getNextSibling()`	`Element`	检索元素的下一个同级元素。
`getNumChildren()`	`Integer`	检索子项的数量。
`getParent()`	`ContainerElement`	检索元素的父元素。
`getPreviousSibling()`	`Element`	检索元素的上一个同级元素。
`getText()`	`String`	以文本字符串的形式检索元素的内容。
`getTextAlignment()`	`TextAlignment`	获取文本对齐方式。
`getType()`	`ElementType`	检索元素的 `ElementType`。
`isAtDocumentEnd()`	`Boolean`	确定元素是否位于 `Document` 的末尾。
`merge()`	`ContainerElement`	将元素与同一类型的上一个同级元素合并。
`removeFromParent()`	`ContainerElement`	从其父元素中移除元素。
`replaceText(searchPattern, replacement)`	`Element`	使用正则表达式将给定文本模式的所有出现替换为给定的替换字符串。
`setAttributes(attributes)`	`ContainerElement`	设置元素的属性。
`setLinkUrl(url)`	`ContainerElement`	设置链接网址。
`setTextAlignment(textAlignment)`	`ContainerElement`	设置文本对齐方式。

`Date`

方法

方法	返回类型	简介
`copy()`	`Date`	返回当前元素的脱离式深层副本。
`getAttributes()`	`Object`	检索元素的属性。
`getDisplayText()`	`String`	返回在文档中呈现的显示值。
`getLocale()`	`String`	返回用于显示值的日期语言区域。
`getNextSibling()`	`Element`	检索元素的下一个同级元素。
`getParent()`	`ContainerElement`	检索元素的父元素。
`getPreviousSibling()`	`Element`	检索元素的上一个同级元素。
`getTimestamp()`	`Date`	返回与日期关联的时间戳。
`getType()`	`ElementType`	检索元素的 `ElementType`。
`isAtDocumentEnd()`	`Boolean`	确定元素是否位于 `Document` 的末尾。
`merge()`	`Date`	将元素与同一类型的上一个同级元素合并。
`removeFromParent()`	`Date`	从其父元素中移除元素。
`setAttributes(attributes)`	`Date`	设置元素的属性。

`Document`

方法

方法	返回类型	简介
`addBookmark(position)`	`Bookmark`	在给定 `Position` 处向第一个标签页添加 `Bookmark`；对于绑定到文档的脚本，则添加到活动标签页。
`addEditor(emailAddress)`	`Document`	将指定用户添加到 `Document` 的编辑者列表中。
`addEditor(user)`	`Document`	将指定用户添加到 `Document` 的编辑者列表中。
`addEditors(emailAddresses)`	`Document`	将指定的用户数组添加到 `Document` 的编辑者列表中。
`addFooter()`	`FooterSection`	向第一个标签页（如果不存在，则为活动标签页）添加页脚部分（如果不存在）。对于绑定到文档的脚本，则会向活动标签页添加页脚部分。
`addHeader()`	`HeaderSection`	在第一个标签页（如果不存在，则在活动标签页）中添加标题部分（如果不存在）。对于绑定到文档的脚本，则在活动标签页中添加标题部分。
`addNamedRange(name, range)`	`NamedRange`	在第一个标签页（对于绑定到文档的脚本，则是在活动标签页）中添加 `NamedRange`，即具有名称和 ID 的 `Range`，以供日后检索。
`addViewer(emailAddress)`	`Document`	将指定用户添加到 `Document` 的观看者列表中。
`addViewer(user)`	`Document`	将指定用户添加到 `Document` 的观看者列表中。
`addViewers(emailAddresses)`	`Document`	将给定用户数组添加到 `Document` 的观看者列表中。
`getActiveTab()`	`Tab`	获取文档中用户当前活跃的 `Tab`。
`getAs(contentType)`	`Blob`	以指定类型的 blob 的形式检索当前 `Document` 内容。
`getBlob()`	`Blob`	以 blob 的形式检索当前的 `Document` 内容。
`getBody()`	`Body`	检索第一个标签页的 `Body`；对于绑定到文档的脚本，则检索活动标签页的 `DocumentBodySection`。
`getBookmark(id)`	`Bookmark`	获取第一个标签页或活动标签页（对于绑定到文档的脚本）中具有给定 ID 的 `Bookmark`。
`getBookmarks()`	`Bookmark[]`	获取第一个标签页中的所有 `Bookmark` 对象，对于绑定到文档的脚本，则获取活动标签页中的所有 `Bookmark` 对象。
`getCursor()`	`Position`	获取用户在当前标签页中的光标。
`getEditors()`	`User[]`	获取此 `Document` 的编辑器列表。
`getFooter()`	`FooterSection`	检索第一个标签页的页脚部分，对于绑定到文档的脚本，则检索活动标签页的页脚部分。
`getFootnotes()`	`Footnote[]`	检索第一个标签页正文中的所有 `Footnote` 元素，或者对于绑定到文档的脚本，则检索活动标签页的正文中的所有 `Footnote` 元素。
`getHeader()`	`HeaderSection`	检索第一个标签页的标题部分，对于绑定到文档的脚本，则检索活动标签页的标题部分。
`getId()`	`String`	检索文档的唯一标识符。
`getLanguage()`	`String`	获取文档的语言代码。
`getName()`	`String`	检索文档的标题。
`getNamedRangeById(id)`	`NamedRange`	获取第一个标签页或活动标签页（对于绑定到文档的脚本）中具有给定 ID 的 `NamedRange`。
`getNamedRanges()`	`NamedRange[]`	获取第一个标签页中的所有 `NamedRange` 对象，对于绑定到文档的脚本，则获取活动标签页中的所有 `NamedRange` 对象。
`getNamedRanges(name)`	`NamedRange[]`	获取第一个标签页（对于绑定到文档的脚本，则为当前标签页）中具有给定名称的所有 `NamedRange` 对象。
`getSelection()`	`Range`	获取用户在“活跃”标签页中的选择。
`getSupportedLanguageCodes()`	`String[]`	获取 Google 文档文件支持的所有语言代码。
`getTab(tabId)`	`Tab`	获取具有指定 ID 的 `Tab`。
`getTabs()`	`Tab[]`	获取文档中的所有非嵌套 `Tab`。
`getUrl()`	`String`	检索用于访问当前文档的网址。
`getViewers()`	`User[]`	获取此 `Document` 的查看者和评论者的列表。
`newPosition(element, offset)`	`Position`	创建一个新的 `Position`，它是相对于第一个标签页中的特定元素（对于绑定到文档的脚本，则是相对于活动标签页）的标签页中位置的引用。
`newRange()`	`RangeBuilder`	创建一个构建器，用于根据第一个标签页中的标签页元素（对于绑定到文档的脚本，则为活动标签页）构建 `Range` 对象。
`removeEditor(emailAddress)`	`Document`	从 `Document` 的编辑者列表中移除指定用户。
`removeEditor(user)`	`Document`	从 `Document` 的编辑者列表中移除指定用户。
`removeViewer(emailAddress)`	`Document`	从 `Document` 的观看者和评论者列表中移除指定用户。
`removeViewer(user)`	`Document`	从 `Document` 的观看者和评论者列表中移除指定用户。
`saveAndClose()`	`void`	保存当前 `Document`。
`setActiveTab(tabId)`	`void`	将当前文档中用户选择的 `Tab` 设置为具有指定 ID 的标签页。
`setCursor(position)`	`Document`	给定 `Position` 时，设置用户的光标。
`setLanguage(languageCode)`	`Document`	设置文档的语言代码。
`setName(name)`	`Document`	设置文档标题。
`setSelection(range)`	`Document`	给定 `Range`，设置用户在当前标签页中的选择。

`DocumentApp`

属性

属性	类型	说明
`Attribute`	`Attribute`	`Attribute` 枚举。
`ElementType`	`ElementType`	`ElementType` 枚举。
`FontFamily`	`FontFamily`	`FontFamily` 枚举。
`GlyphType`	`GlyphType`	`GlyphType` 枚举。
`HorizontalAlignment`	`HorizontalAlignment`	`HorizontalAlignment` 枚举。
`ParagraphHeading`	`ParagraphHeading`	`ParagraphHeading` 枚举。
`PositionedLayout`	`PositionedLayout`	`PositionedLayout` 枚举。
`TextAlignment`	`TextAlignment`	`TextAlignment` 枚举。
`VerticalAlignment`	`VerticalAlignment`	`VerticalAlignment` 枚举。

方法

方法	返回类型	简介
`create(name)`	`Document`	创建并返回新的文档。
`getActiveDocument()`	`Document`	返回脚本绑定到容器的文档。
`getUi()`	`Ui`	返回文档界面环境的实例，以便脚本添加菜单、对话框和边栏等功能。
`openById(id)`	`Document`	返回具有指定 ID 的文档。
`openByUrl(url)`	`Document`	打开并返回指定网址的文档。

`DocumentTab`

方法

方法	返回类型	简介
`addBookmark(position)`	`Bookmark`	在给定的 `Position` 中添加 `Bookmark`。
`addFooter()`	`FooterSection`	添加标签页页脚部分（如果不存在）。
`addHeader()`	`HeaderSection`	添加标签页标题部分（如果不存在）。
`addNamedRange(name, range)`	`NamedRange`	添加一个 `NamedRange`，这是一个具有名称和 ID 的 `Range`，可供日后检索。
`getBody()`	`Body`	检索标签页的 `Body`。
`getBookmark(id)`	`Bookmark`	获取具有指定 ID 的 `Bookmark`。
`getBookmarks()`	`Bookmark[]`	获取标签页中的所有 `Bookmark` 对象。
`getFooter()`	`FooterSection`	检索标签页的页脚部分（如果存在）。
`getFootnotes()`	`Footnote[]`	检索标签页正文中的所有 `Footnote` 元素。
`getHeader()`	`HeaderSection`	检索标签页的标题部分（如果存在）。
`getNamedRangeById(id)`	`NamedRange`	获取具有指定 ID 的 `NamedRange`。
`getNamedRanges()`	`NamedRange[]`	获取标签页中的所有 `NamedRange` 对象。
`getNamedRanges(name)`	`NamedRange[]`	获取具有给定名称的标签页中的所有 `NamedRange` 对象。
`newPosition(element, offset)`	`Position`	创建一个新的 `Position`，它是对标签页中相对于特定元素的位置的引用。
`newRange()`	`RangeBuilder`	创建用于从标签页元素构建 `Range` 对象的构建器。

`Element`

方法

方法	返回类型	简介
`asBody()`	`Body`	以 `Body` 的形式返回当前元素。
`asDate()`	`Date`	以 `Date` 的形式返回当前元素。
`asEquation()`	`Equation`	以 `Equation` 的形式返回当前元素。
`asEquationFunction()`	`EquationFunction`	以 `EquationFunction` 的形式返回当前元素。
`asEquationFunctionArgumentSeparator()`	`EquationFunctionArgumentSeparator`	以 `EquationFunctionArgumentSeparator` 的形式返回当前元素。
`asEquationSymbol()`	`EquationSymbol`	以 `EquationSymbol` 的形式返回当前元素。
`asFooterSection()`	`FooterSection`	以 `FooterSection` 的形式返回当前元素。
`asFootnote()`	`Footnote`	以 `Footnote` 的形式返回当前元素。
`asFootnoteSection()`	`FootnoteSection`	以 `FootnoteSection` 的形式返回当前元素。
`asHeaderSection()`	`HeaderSection`	以 `HeaderSection` 的形式返回当前元素。
`asHorizontalRule()`	`HorizontalRule`	以 `HorizontalRule` 的形式返回当前元素。
`asInlineDrawing()`	`InlineDrawing`	以 `InlineDrawing` 的形式返回当前元素。
`asInlineImage()`	`InlineImage`	以 `InlineImage` 的形式返回当前元素。
`asListItem()`	`ListItem`	以 `ListItem` 的形式返回当前元素。
`asPageBreak()`	`PageBreak`	以 `PageBreak` 的形式返回当前元素。
`asParagraph()`	`Paragraph`	以 `Paragraph` 的形式返回当前元素。
`asPerson()`	`Person`	以 `Person` 的形式返回当前元素。
`asRichLink()`	`RichLink`	以 `RichLink` 的形式返回当前元素，例如 Google 表格文件的链接。
`asTable()`	`Table`	以 `Table` 的形式返回当前元素。
`asTableCell()`	`TableCell`	以 `TableCell` 的形式返回当前元素。
`asTableOfContents()`	`TableOfContents`	以 `TableOfContents` 的形式返回当前元素。
`asTableRow()`	`TableRow`	以 `TableRow` 的形式返回当前元素。
`asText()`	`Text`	以 `Text` 的形式返回当前元素。
`copy()`	`Element`	返回当前元素的脱离式深层副本。
`getAttributes()`	`Object`	检索元素的属性。
`getNextSibling()`	`Element`	检索元素的下一个同级元素。
`getParent()`	`ContainerElement`	检索元素的父元素。
`getPreviousSibling()`	`Element`	检索元素的上一个同级元素。
`getType()`	`ElementType`	检索元素的 `ElementType`。
`isAtDocumentEnd()`	`Boolean`	确定元素是否位于 `Document` 的末尾。
`merge()`	`Element`	将元素与同一类型的上一个同级元素合并。
`removeFromParent()`	`Element`	从其父元素中移除元素。
`setAttributes(attributes)`	`Element`	设置元素的属性。

`ElementType`

属性

属性	类型	说明
`BODY_SECTION`	`Enum`	与 `Body` 元素对应的类型。
`COMMENT_SECTION`	`Enum`	与 `CommentSection` 元素对应的类型。
`DATE`	`Enum`	与 `Date` 元素对应的类型。
`EQUATION`	`Enum`	与 `Equation` 元素对应的类型。
`EQUATION_FUNCTION`	`Enum`	与 `EquationFunction` 元素对应的类型。
`EQUATION_FUNCTION_ARGUMENT_SEPARATOR`	`Enum`	与 `EquationFunctionArgumentSeparator` 元素对应的类型。
`EQUATION_SYMBOL`	`Enum`	与 `EquationSymbol` 元素对应的类型。
`RICH_LINK`	`Enum`	与 `RichLink` 元素对应的类型。
`FOOTER_SECTION`	`Enum`	与 `FooterSection` 元素对应的类型。
`FOOTNOTE`	`Enum`	与 `Footnote` 元素对应的类型。
`FOOTNOTE_SECTION`	`Enum`	与 `FootnoteSection` 元素对应的类型。
`HEADER_SECTION`	`Enum`	与 `HeaderSection` 元素对应的类型。
`HORIZONTAL_RULE`	`Enum`	与 `HorizontalRule` 元素对应的类型。
`INLINE_DRAWING`	`Enum`	与 `InlineDrawing` 元素对应的类型。
`INLINE_IMAGE`	`Enum`	与 `InlineImage` 元素对应的类型。
`LIST_ITEM`	`Enum`	与 `ListItem` 元素对应的类型。
`PAGE_BREAK`	`Enum`	与 `PageBreak` 元素对应的类型。
`PARAGRAPH`	`Enum`	与 `Paragraph` 元素对应的类型。
`PERSON`	`Enum`	与 `Person` 元素对应的类型。
`TABLE`	`Enum`	与 `Table` 元素对应的类型。
`TABLE_CELL`	`Enum`	与 `TableCell` 元素对应的类型。
`TABLE_OF_CONTENTS`	`Enum`	与 `TableOfContents` 元素对应的类型。
`TABLE_ROW`	`Enum`	与 `TableRow` 元素对应的类型。
`TEXT`	`Enum`	与 `Text` 元素对应的类型。
`UNSUPPORTED`	`Enum`	与 `UnsupportedElement` 对应的类型。

`Equation`

方法

方法	返回类型	简介
`clear()`	`Equation`	清除元素的内容。
`copy()`	`Equation`	返回当前元素的脱离式深层副本。
`editAsText()`	`Text`	获取当前元素的 `Text` 版本，以供修改。
`findElement(elementType)`	`RangeElement`	在元素的内容中搜索指定类型的后代。
`findElement(elementType, from)`	`RangeElement`	从指定的 `RangeElement` 开始，在元素的内容中搜索指定类型的后代。
`findText(searchPattern)`	`RangeElement`	使用正则表达式在元素内容中搜索指定的文本模式。
`findText(searchPattern, from)`	`RangeElement`	从给定搜索结果开始，在元素内容中搜索指定的文本模式。
`getAttributes()`	`Object`	检索元素的属性。
`getChild(childIndex)`	`Element`	检索指定子索引位置的子元素。
`getChildIndex(child)`	`Integer`	检索指定子元素的子元素索引。
`getLinkUrl()`	`String`	检索链接网址。
`getNextSibling()`	`Element`	检索元素的下一个同级元素。
`getNumChildren()`	`Integer`	检索子项的数量。
`getParent()`	`ContainerElement`	检索元素的父元素。
`getPreviousSibling()`	`Element`	检索元素的上一个同级元素。
`getText()`	`String`	以文本字符串的形式检索元素的内容。
`getTextAlignment()`	`TextAlignment`	获取文本对齐方式。
`getType()`	`ElementType`	检索元素的 `ElementType`。
`isAtDocumentEnd()`	`Boolean`	确定元素是否位于 `Document` 的末尾。
`merge()`	`Equation`	将元素与同一类型的上一个同级元素合并。
`removeFromParent()`	`Equation`	从其父元素中移除元素。
`replaceText(searchPattern, replacement)`	`Element`	使用正则表达式将给定文本模式的所有出现替换为给定的替换字符串。
`setAttributes(attributes)`	`Equation`	设置元素的属性。
`setLinkUrl(url)`	`Equation`	设置链接网址。
`setTextAlignment(textAlignment)`	`Equation`	设置文本对齐方式。

`EquationFunction`

方法

方法	返回类型	简介
`clear()`	`EquationFunction`	清除元素的内容。
`copy()`	`EquationFunction`	返回当前元素的脱离式深层副本。
`editAsText()`	`Text`	获取当前元素的 `Text` 版本，以供修改。
`findElement(elementType)`	`RangeElement`	在元素的内容中搜索指定类型的后代。
`findElement(elementType, from)`	`RangeElement`	从指定的 `RangeElement` 开始，在元素的内容中搜索指定类型的后代。
`findText(searchPattern)`	`RangeElement`	使用正则表达式在元素内容中搜索指定的文本模式。
`findText(searchPattern, from)`	`RangeElement`	从给定搜索结果开始，在元素内容中搜索指定的文本模式。
`getAttributes()`	`Object`	检索元素的属性。
`getChild(childIndex)`	`Element`	检索指定子索引位置的子元素。
`getChildIndex(child)`	`Integer`	检索指定子元素的子元素索引。
`getCode()`	`String`	检索与方程函数对应的代码。
`getLinkUrl()`	`String`	检索链接网址。
`getNextSibling()`	`Element`	检索元素的下一个同级元素。
`getNumChildren()`	`Integer`	检索子项的数量。
`getParent()`	`ContainerElement`	检索元素的父元素。
`getPreviousSibling()`	`Element`	检索元素的上一个同级元素。
`getText()`	`String`	以文本字符串的形式检索元素的内容。
`getTextAlignment()`	`TextAlignment`	获取文本对齐方式。
`getType()`	`ElementType`	检索元素的 `ElementType`。
`isAtDocumentEnd()`	`Boolean`	确定元素是否位于 `Document` 的末尾。
`merge()`	`EquationFunction`	将元素与同一类型的上一个同级元素合并。
`removeFromParent()`	`EquationFunction`	从其父元素中移除元素。
`replaceText(searchPattern, replacement)`	`Element`	使用正则表达式将给定文本模式的所有出现替换为给定的替换字符串。
`setAttributes(attributes)`	`EquationFunction`	设置元素的属性。
`setLinkUrl(url)`	`EquationFunction`	设置链接网址。
`setTextAlignment(textAlignment)`	`EquationFunction`	设置文本对齐方式。

`EquationFunctionArgumentSeparator`

方法

方法	返回类型	简介
`copy()`	`EquationFunctionArgumentSeparator`	返回当前元素的脱离式深层副本。
`getAttributes()`	`Object`	检索元素的属性。
`getNextSibling()`	`Element`	检索元素的下一个同级元素。
`getParent()`	`ContainerElement`	检索元素的父元素。
`getPreviousSibling()`	`Element`	检索元素的上一个同级元素。
`getType()`	`ElementType`	检索元素的 `ElementType`。
`isAtDocumentEnd()`	`Boolean`	确定元素是否位于 `Document` 的末尾。
`merge()`	`EquationFunctionArgumentSeparator`	将元素与同一类型的上一个同级元素合并。
`removeFromParent()`	`EquationFunctionArgumentSeparator`	从其父元素中移除元素。
`setAttributes(attributes)`	`EquationFunctionArgumentSeparator`	设置元素的属性。

`EquationSymbol`

方法

方法	返回类型	简介
`copy()`	`EquationSymbol`	返回当前元素的脱离式深层副本。
`getAttributes()`	`Object`	检索元素的属性。
`getCode()`	`String`	检索与等式符号对应的代码。
`getNextSibling()`	`Element`	检索元素的下一个同级元素。
`getParent()`	`ContainerElement`	检索元素的父元素。
`getPreviousSibling()`	`Element`	检索元素的上一个同级元素。
`getType()`	`ElementType`	检索元素的 `ElementType`。
`isAtDocumentEnd()`	`Boolean`	确定元素是否位于 `Document` 的末尾。
`merge()`	`EquationSymbol`	将元素与同一类型的上一个同级元素合并。
`removeFromParent()`	`EquationSymbol`	从其父元素中移除元素。
`setAttributes(attributes)`	`EquationSymbol`	设置元素的属性。

`FontFamily`

`FooterSection`

方法

方法	返回类型	简介
`appendHorizontalRule()`	`HorizontalRule`	创建并附加新的 `HorizontalRule`。
`appendImage(image)`	`InlineImage`	从指定的图片 blob 创建并附加新的 `InlineImage`。
`appendImage(image)`	`InlineImage`	附加给定的 `InlineImage`。
`appendListItem(listItem)`	`ListItem`	附加给定的 `ListItem`。
`appendListItem(text)`	`ListItem`	创建并附加包含指定文本内容的新 `ListItem`。
`appendParagraph(paragraph)`	`Paragraph`	附加给定的 `Paragraph`。
`appendParagraph(text)`	`Paragraph`	创建并附加包含指定文本内容的新 `Paragraph`。
`appendTable()`	`Table`	创建并附加新的 `Table`。
`appendTable(cells)`	`Table`	为每个指定的字符串值附加一个包含 `TableCell` 的新 `Table`。
`appendTable(table)`	`Table`	附加给定的 `Table`。
`clear()`	`FooterSection`	清除元素的内容。
`copy()`	`FooterSection`	返回当前元素的脱离式深层副本。
`editAsText()`	`Text`	获取当前元素的 `Text` 版本，以供修改。
`findElement(elementType)`	`RangeElement`	在元素的内容中搜索指定类型的后代。
`findElement(elementType, from)`	`RangeElement`	从指定的 `RangeElement` 开始，在元素的内容中搜索指定类型的后代。
`findText(searchPattern)`	`RangeElement`	使用正则表达式在元素内容中搜索指定的文本模式。
`findText(searchPattern, from)`	`RangeElement`	从给定搜索结果开始，在元素内容中搜索指定的文本模式。
`getAttributes()`	`Object`	检索元素的属性。
`getChild(childIndex)`	`Element`	检索指定子索引位置的子元素。
`getChildIndex(child)`	`Integer`	检索指定子元素的子元素索引。
`getImages()`	`InlineImage[]`	检索该部分中包含的所有 `InlineImages`。
`getListItems()`	`ListItem[]`	检索该部分中包含的所有 `ListItems`。
`getNumChildren()`	`Integer`	检索子项的数量。
`getParagraphs()`	`Paragraph[]`	检索该部分中包含的所有 `Paragraphs`（包括 `ListItems`）。
`getParent()`	`ContainerElement`	检索元素的父元素。
`getTables()`	`Table[]`	检索该部分中包含的所有 `Tables`。
`getText()`	`String`	以文本字符串的形式检索元素的内容。
`getTextAlignment()`	`TextAlignment`	获取文本对齐方式。
`getType()`	`ElementType`	检索元素的 `ElementType`。
`insertHorizontalRule(childIndex)`	`HorizontalRule`	在指定索引处创建并插入新的 `HorizontalRule`。
`insertImage(childIndex, image)`	`InlineImage`	在指定位置从指定图片 blob 创建并插入 `InlineImage`。
`insertImage(childIndex, image)`	`InlineImage`	在指定的索引处插入给定的 `InlineImage`。
`insertListItem(childIndex, listItem)`	`ListItem`	在指定的索引处插入给定的 `ListItem`。
`insertListItem(childIndex, text)`	`ListItem`	在指定索引处创建并插入包含指定文本内容的新 `ListItem`。
`insertParagraph(childIndex, paragraph)`	`Paragraph`	在指定的索引处插入给定的 `Paragraph`。
`insertParagraph(childIndex, text)`	`Paragraph`	在指定索引处创建并插入包含指定文本内容的新 `Paragraph`。
`insertTable(childIndex)`	`Table`	在指定索引处创建并插入新的 `Table`。
`insertTable(childIndex, cells)`	`Table`	在指定索引处创建并插入包含指定单元格的新 `Table`。
`insertTable(childIndex, table)`	`Table`	在指定的索引处插入给定的 `Table`。
`removeChild(child)`	`FooterSection`	移除指定的子元素。
`removeFromParent()`	`FooterSection`	从其父元素中移除元素。
`replaceText(searchPattern, replacement)`	`Element`	使用正则表达式将给定文本模式的所有出现替换为给定的替换字符串。
`setAttributes(attributes)`	`FooterSection`	设置元素的属性。
`setText(text)`	`FooterSection`	将内容设置为纯文本。
`setTextAlignment(textAlignment)`	`FooterSection`	设置文本对齐方式。

`Footnote`

方法

方法	返回类型	简介
`copy()`	`Footnote`	返回当前元素的脱离式深层副本。
`getAttributes()`	`Object`	检索元素的属性。
`getFootnoteContents()`	`FootnoteSection`	检索脚注元素的内容。
`getNextSibling()`	`Element`	检索元素的下一个同级元素。
`getParent()`	`ContainerElement`	检索元素的父元素。
`getPreviousSibling()`	`Element`	检索元素的上一个同级元素。
`getType()`	`ElementType`	检索元素的 `ElementType`。
`isAtDocumentEnd()`	`Boolean`	确定元素是否位于 `Document` 的末尾。
`removeFromParent()`	`Footnote`	从其父元素中移除元素。
`setAttributes(attributes)`	`Footnote`	设置元素的属性。

`FootnoteSection`

方法

方法	返回类型	简介
`appendParagraph(paragraph)`	`Paragraph`	附加给定的 `Paragraph`。
`appendParagraph(text)`	`Paragraph`	创建并附加包含指定文本内容的新 `Paragraph`。
`clear()`	`FootnoteSection`	清除元素的内容。
`copy()`	`FootnoteSection`	返回当前元素的脱离式深层副本。
`editAsText()`	`Text`	获取当前元素的 `Text` 版本，以供修改。
`findElement(elementType)`	`RangeElement`	在元素的内容中搜索指定类型的后代。
`findElement(elementType, from)`	`RangeElement`	从指定的 `RangeElement` 开始，在元素的内容中搜索指定类型的后代。
`findText(searchPattern)`	`RangeElement`	使用正则表达式在元素内容中搜索指定的文本模式。
`findText(searchPattern, from)`	`RangeElement`	从给定搜索结果开始，在元素内容中搜索指定的文本模式。
`getAttributes()`	`Object`	检索元素的属性。
`getChild(childIndex)`	`Element`	检索指定子索引位置的子元素。
`getChildIndex(child)`	`Integer`	检索指定子元素的子元素索引。
`getNextSibling()`	`Element`	检索元素的下一个同级元素。
`getNumChildren()`	`Integer`	检索子项的数量。
`getParagraphs()`	`Paragraph[]`	检索该部分中包含的所有 `Paragraphs`（包括 `ListItems`）。
`getParent()`	`ContainerElement`	检索元素的父元素。
`getPreviousSibling()`	`Element`	检索元素的上一个同级元素。
`getText()`	`String`	以文本字符串的形式检索元素的内容。
`getTextAlignment()`	`TextAlignment`	获取文本对齐方式。
`getType()`	`ElementType`	检索元素的 `ElementType`。
`insertParagraph(childIndex, paragraph)`	`Paragraph`	在指定的索引处插入给定的 `Paragraph`。
`insertParagraph(childIndex, text)`	`Paragraph`	在指定索引处创建并插入包含指定文本内容的新 `Paragraph`。
`removeChild(child)`	`FootnoteSection`	移除指定的子元素。
`removeFromParent()`	`FootnoteSection`	从其父元素中移除元素。
`replaceText(searchPattern, replacement)`	`Element`	使用正则表达式将给定文本模式的所有出现替换为给定的替换字符串。
`setAttributes(attributes)`	`FootnoteSection`	设置元素的属性。
`setText(text)`	`FootnoteSection`	将内容设置为纯文本。
`setTextAlignment(textAlignment)`	`FootnoteSection`	设置文本对齐方式。

`GlyphType`

属性

属性	类型	说明
`BULLET`	`Enum`	默认的圆形填充圆点。
`HOLLOW_BULLET`	`Enum`	空心子弹。
`SQUARE_BULLET`	`Enum`	方形项目符号。
`NUMBER`	`Enum`	基于数字的项目符号。
`LATIN_UPPER`	`Enum`	拉丁大写圆点。
`LATIN_LOWER`	`Enum`	小写拉丁文数字符号。
`ROMAN_UPPER`	`Enum`	罗马数字，大写圆点。
`ROMAN_LOWER`	`Enum`	罗马数字，小写圆点。

`HeaderSection`

方法

方法	返回类型	简介
`appendHorizontalRule()`	`HorizontalRule`	创建并附加新的 `HorizontalRule`。
`appendImage(image)`	`InlineImage`	从指定的图片 blob 创建并附加新的 `InlineImage`。
`appendImage(image)`	`InlineImage`	附加给定的 `InlineImage`。
`appendListItem(listItem)`	`ListItem`	附加给定的 `ListItem`。
`appendListItem(text)`	`ListItem`	创建并附加包含指定文本内容的新 `ListItem`。
`appendParagraph(paragraph)`	`Paragraph`	附加给定的 `Paragraph`。
`appendParagraph(text)`	`Paragraph`	创建并附加包含指定文本内容的新 `Paragraph`。
`appendTable()`	`Table`	创建并附加新的 `Table`。
`appendTable(cells)`	`Table`	为每个指定的字符串值附加一个包含 `TableCell` 的新 `Table`。
`appendTable(table)`	`Table`	附加给定的 `Table`。
`clear()`	`HeaderSection`	清除元素的内容。
`copy()`	`HeaderSection`	返回当前元素的脱离式深层副本。
`editAsText()`	`Text`	获取当前元素的 `Text` 版本，以供修改。
`findElement(elementType)`	`RangeElement`	在元素的内容中搜索指定类型的后代。
`findElement(elementType, from)`	`RangeElement`	从指定的 `RangeElement` 开始，在元素的内容中搜索指定类型的后代。
`findText(searchPattern)`	`RangeElement`	使用正则表达式在元素内容中搜索指定的文本模式。
`findText(searchPattern, from)`	`RangeElement`	从给定搜索结果开始，在元素内容中搜索指定的文本模式。
`getAttributes()`	`Object`	检索元素的属性。
`getChild(childIndex)`	`Element`	检索指定子索引位置的子元素。
`getChildIndex(child)`	`Integer`	检索指定子元素的子元素索引。
`getImages()`	`InlineImage[]`	检索该部分中包含的所有 `InlineImages`。
`getListItems()`	`ListItem[]`	检索该部分中包含的所有 `ListItems`。
`getNumChildren()`	`Integer`	检索子项的数量。
`getParagraphs()`	`Paragraph[]`	检索该部分中包含的所有 `Paragraphs`（包括 `ListItems`）。
`getParent()`	`ContainerElement`	检索元素的父元素。
`getTables()`	`Table[]`	检索该部分中包含的所有 `Tables`。
`getText()`	`String`	以文本字符串的形式检索元素的内容。
`getTextAlignment()`	`TextAlignment`	获取文本对齐方式。
`getType()`	`ElementType`	检索元素的 `ElementType`。
`insertHorizontalRule(childIndex)`	`HorizontalRule`	在指定索引处创建并插入新的 `HorizontalRule`。
`insertImage(childIndex, image)`	`InlineImage`	在指定位置从指定图片 blob 创建并插入 `InlineImage`。
`insertImage(childIndex, image)`	`InlineImage`	在指定的索引处插入给定的 `InlineImage`。
`insertListItem(childIndex, listItem)`	`ListItem`	在指定的索引处插入给定的 `ListItem`。
`insertListItem(childIndex, text)`	`ListItem`	在指定索引处创建并插入包含指定文本内容的新 `ListItem`。
`insertParagraph(childIndex, paragraph)`	`Paragraph`	在指定的索引处插入给定的 `Paragraph`。
`insertParagraph(childIndex, text)`	`Paragraph`	在指定索引处创建并插入包含指定文本内容的新 `Paragraph`。
`insertTable(childIndex)`	`Table`	在指定索引处创建并插入新的 `Table`。
`insertTable(childIndex, cells)`	`Table`	在指定索引处创建并插入包含指定单元格的新 `Table`。
`insertTable(childIndex, table)`	`Table`	在指定的索引处插入给定的 `Table`。
`removeChild(child)`	`HeaderSection`	移除指定的子元素。
`removeFromParent()`	`HeaderSection`	从其父元素中移除元素。
`replaceText(searchPattern, replacement)`	`Element`	使用正则表达式将给定文本模式的所有出现替换为给定的替换字符串。
`setAttributes(attributes)`	`HeaderSection`	设置元素的属性。
`setText(text)`	`HeaderSection`	将内容设置为纯文本。
`setTextAlignment(textAlignment)`	`HeaderSection`	设置文本对齐方式。

`HorizontalAlignment`

属性

属性	类型	说明
`LEFT`	`Enum`	“左对齐”选项。
`CENTER`	`Enum`	居中对齐选项。
`RIGHT`	`Enum`	右对齐选项。
`JUSTIFY`	`Enum`	justify-alignment 选项。

`HorizontalRule`

方法

方法	返回类型	简介
`copy()`	`HorizontalRule`	返回当前元素的脱离式深层副本。
`getAttributes()`	`Object`	检索元素的属性。
`getNextSibling()`	`Element`	检索元素的下一个同级元素。
`getParent()`	`ContainerElement`	检索元素的父元素。
`getPreviousSibling()`	`Element`	检索元素的上一个同级元素。
`getType()`	`ElementType`	检索元素的 `ElementType`。
`isAtDocumentEnd()`	`Boolean`	确定元素是否位于 `Document` 的末尾。
`removeFromParent()`	`HorizontalRule`	从其父元素中移除元素。
`setAttributes(attributes)`	`HorizontalRule`	设置元素的属性。

`InlineDrawing`

方法

方法	返回类型	简介
`copy()`	`InlineDrawing`	返回当前元素的脱离式深层副本。
`getAltDescription()`	`String`	返回绘图的备用说明。
`getAltTitle()`	`String`	返回绘图的副标题。
`getAttributes()`	`Object`	检索元素的属性。
`getNextSibling()`	`Element`	检索元素的下一个同级元素。
`getParent()`	`ContainerElement`	检索元素的父元素。
`getPreviousSibling()`	`Element`	检索元素的上一个同级元素。
`getType()`	`ElementType`	检索元素的 `ElementType`。
`isAtDocumentEnd()`	`Boolean`	确定元素是否位于 `Document` 的末尾。
`merge()`	`InlineDrawing`	将元素与同一类型的上一个同级元素合并。
`removeFromParent()`	`InlineDrawing`	从其父元素中移除元素。
`setAltDescription(description)`	`InlineDrawing`	设置绘图的备用说明。
`setAltTitle(title)`	`InlineDrawing`	设置绘图的副标题。
`setAttributes(attributes)`	`InlineDrawing`	设置元素的属性。

`InlineImage`

方法

方法	返回类型	简介
`copy()`	`InlineImage`	返回当前元素的脱离式深层副本。
`getAltDescription()`	`String`	返回图片的备用说明。
`getAltTitle()`	`String`	返回图片的副标题。
`getAs(contentType)`	`Blob`	将此对象内的数据作为转换为指定内容类型的 blob 返回。
`getAttributes()`	`Object`	检索元素的属性。
`getBlob()`	`Blob`	以 blob 的形式返回此对象内的数据。
`getHeight()`	`Integer`	检索图片的高度（以像素为单位）。
`getLinkUrl()`	`String`	检索链接网址。
`getNextSibling()`	`Element`	检索元素的下一个同级元素。
`getParent()`	`ContainerElement`	检索元素的父元素。
`getPreviousSibling()`	`Element`	检索元素的上一个同级元素。
`getType()`	`ElementType`	检索元素的 `ElementType`。
`getWidth()`	`Integer`	检索图片的宽度（以像素为单位）。
`isAtDocumentEnd()`	`Boolean`	确定元素是否位于 `Document` 的末尾。
`merge()`	`InlineImage`	将元素与同一类型的上一个同级元素合并。
`removeFromParent()`	`InlineImage`	从其父元素中移除元素。
`setAltDescription(description)`	`InlineImage`	设置图片的备用说明。
`setAltTitle(title)`	`InlineImage`	设置图片的副标题。
`setAttributes(attributes)`	`InlineImage`	设置元素的属性。
`setHeight(height)`	`InlineImage`	设置图片的高度（以像素为单位）。
`setLinkUrl(url)`	`InlineImage`	设置链接网址。
`setWidth(width)`	`InlineImage`	设置图片的宽度（以像素为单位）。

`ListItem`

方法

方法	返回类型	简介
`addPositionedImage(image)`	`PositionedImage`	从指定的图片 blob 创建并插入新的 `PositionedImage`。
`appendHorizontalRule()`	`HorizontalRule`	创建并附加新的 `HorizontalRule`。
`appendInlineImage(image)`	`InlineImage`	从指定的图片 blob 创建并附加新的 `InlineImage`。
`appendInlineImage(image)`	`InlineImage`	附加给定的 `InlineImage`。
`appendPageBreak()`	`PageBreak`	创建并附加新的 `PageBreak`。
`appendPageBreak(pageBreak)`	`PageBreak`	附加给定的 `PageBreak`。
`appendText(text)`	`Text`	创建并附加具有指定内容的新 `Text` 元素。
`appendText(text)`	`Text`	附加给定的 `Text` 元素。
`clear()`	`ListItem`	清除元素的内容。
`copy()`	`ListItem`	返回当前元素的脱离式深层副本。
`editAsText()`	`Text`	获取当前元素的 `Text` 版本，以供修改。
`findElement(elementType)`	`RangeElement`	在元素的内容中搜索指定类型的后代。
`findElement(elementType, from)`	`RangeElement`	从指定的 `RangeElement` 开始，在元素的内容中搜索指定类型的后代。
`findText(searchPattern)`	`RangeElement`	使用正则表达式在元素内容中搜索指定的文本模式。
`findText(searchPattern, from)`	`RangeElement`	从给定搜索结果开始，在元素内容中搜索指定的文本模式。
`getAlignment()`	`HorizontalAlignment`	检索 `HorizontalAlignment`。
`getAttributes()`	`Object`	检索元素的属性。
`getChild(childIndex)`	`Element`	检索指定子索引位置的子元素。
`getChildIndex(child)`	`Integer`	检索指定子元素的子元素索引。
`getGlyphType()`	`GlyphType`	检索列表项的 `GlyphType`。
`getHeading()`	`ParagraphHeading`	检索 `ParagraphHeading`。
`getIndentEnd()`	`Number`	检索结束缩进，以点为单位。
`getIndentFirstLine()`	`Number`	检索首行缩进（以点为单位）。
`getIndentStart()`	`Number`	检索起始缩进。
`getLineSpacing()`	`Number`	检索行间距（以点为单位）。
`getLinkUrl()`	`String`	检索链接网址。
`getListId()`	`String`	检索列表 ID。
`getNestingLevel()`	`Integer`	检索列表项的嵌套级别。
`getNextSibling()`	`Element`	检索元素的下一个同级元素。
`getNumChildren()`	`Integer`	检索子项的数量。
`getParent()`	`ContainerElement`	检索元素的父元素。
`getPositionedImage(id)`	`PositionedImage`	根据图片的 ID 获取 `PositionedImage`。
`getPositionedImages()`	`PositionedImage[]`	获取锚定到段落的所有 `PositionedImage` 对象。
`getPreviousSibling()`	`Element`	检索元素的上一个同级元素。
`getSpacingAfter()`	`Number`	检索元素后面的间距（以点为单位）。
`getSpacingBefore()`	`Number`	检索元素前面的间距（以点为单位）。
`getText()`	`String`	以文本字符串的形式检索元素的内容。
`getTextAlignment()`	`TextAlignment`	获取文本对齐方式。
`getType()`	`ElementType`	检索元素的 `ElementType`。
`insertHorizontalRule(childIndex)`	`HorizontalRule`	在指定索引处创建并插入 `HorizontalRule`。
`insertInlineImage(childIndex, image)`	`InlineImage`	在指定的索引处，从指定的图片 blob 创建并插入新的 `InlineImage`。
`insertInlineImage(childIndex, image)`	`InlineImage`	在指定的索引处插入给定的 `InlineImage`。
`insertPageBreak(childIndex)`	`PageBreak`	在指定索引处创建并插入新的 `PageBreak`。
`insertPageBreak(childIndex, pageBreak)`	`PageBreak`	在指定的索引处插入给定的 `PageBreak`。
`insertText(childIndex, text)`	`Text`	在指定索引处创建并插入新的文本元素。
`insertText(childIndex, text)`	`Text`	在指定索引处插入指定的 `Text` 元素，并附带指定的文本内容。
`isAtDocumentEnd()`	`Boolean`	确定元素是否位于 `Document` 的末尾。
`isLeftToRight()`	`Boolean`	检索从左到右的设置。
`merge()`	`ListItem`	将元素与同一类型的上一个同级元素合并。
`removeChild(child)`	`ListItem`	移除指定的子元素。
`removeFromParent()`	`ListItem`	从其父元素中移除元素。
`removePositionedImage(id)`	`Boolean`	按图片 ID 移除 `PositionedImage`。
`replaceText(searchPattern, replacement)`	`Element`	使用正则表达式将给定文本模式的所有出现替换为给定的替换字符串。
`setAlignment(alignment)`	`ListItem`	设置 `HorizontalAlignment`。
`setAttributes(attributes)`	`ListItem`	设置元素的属性。
`setGlyphType(glyphType)`	`ListItem`	设置列表项的 `GlyphType`。
`setHeading(heading)`	`ListItem`	设置 `ParagraphHeading`。
`setIndentEnd(indentEnd)`	`ListItem`	设置末尾缩进，以点为单位。
`setIndentFirstLine(indentFirstLine)`	`ListItem`	设置首行缩进（以点为单位）。
`setIndentStart(indentStart)`	`ListItem`	设置起始缩进，以点为单位。
`setLeftToRight(leftToRight)`	`ListItem`	设置从左到右的方向。
`setLineSpacing(multiplier)`	`ListItem`	设置行间距，作为一个量，表示用于间距的行数。
`setLinkUrl(url)`	`ListItem`	设置链接网址。
`setListId(listItem)`	`ListItem`	设置列表 ID。
`setNestingLevel(nestingLevel)`	`ListItem`	设置列表项的嵌套级别。
`setSpacingAfter(spacingAfter)`	`ListItem`	设置元素后面的间距（以点为单位）。
`setSpacingBefore(spacingBefore)`	`ListItem`	设置元素前面的间距（以点为单位）。
`setText(text)`	`void`	将列表项的内容设置为文本。
`setTextAlignment(textAlignment)`	`ListItem`	设置文本对齐方式。

`NamedRange`

方法

方法	返回类型	简介
`getId()`	`String`	获取此 `NamedRange` 的 ID。
`getName()`	`String`	获取此 `NamedRange` 的名称。
`getRange()`	`Range`	获取与此 `NamedRange` 关联的元素范围。
`remove()`	`void`	从标签页中移除此 `NamedRange`。

`PageBreak`

方法

方法	返回类型	简介
`copy()`	`PageBreak`	返回当前元素的脱离式深层副本。
`getAttributes()`	`Object`	检索元素的属性。
`getNextSibling()`	`Element`	检索元素的下一个同级元素。
`getParent()`	`ContainerElement`	检索元素的父元素。
`getPreviousSibling()`	`Element`	检索元素的上一个同级元素。
`getType()`	`ElementType`	检索元素的 `ElementType`。
`isAtDocumentEnd()`	`Boolean`	确定元素是否位于 `Document` 的末尾。
`removeFromParent()`	`PageBreak`	从其父元素中移除元素。
`setAttributes(attributes)`	`PageBreak`	设置元素的属性。

`Paragraph`

方法

方法	返回类型	简介
`addPositionedImage(image)`	`PositionedImage`	从指定的图片 blob 创建并插入新的 `PositionedImage`。
`appendHorizontalRule()`	`HorizontalRule`	创建并附加新的 `HorizontalRule`。
`appendInlineImage(image)`	`InlineImage`	从指定的图片 blob 创建并附加新的 `InlineImage`。
`appendInlineImage(image)`	`InlineImage`	附加给定的 `InlineImage`。
`appendPageBreak()`	`PageBreak`	创建并附加新的 `PageBreak`。
`appendPageBreak(pageBreak)`	`PageBreak`	附加给定的 `PageBreak`。
`appendText(text)`	`Text`	创建并附加具有指定内容的新 `Text` 元素。
`appendText(text)`	`Text`	附加给定的 `Text` 元素。
`clear()`	`Paragraph`	清除元素的内容。
`copy()`	`Paragraph`	返回当前元素的脱离式深层副本。
`editAsText()`	`Text`	获取当前元素的 `Text` 版本，以供修改。
`findElement(elementType)`	`RangeElement`	在元素的内容中搜索指定类型的后代。
`findElement(elementType, from)`	`RangeElement`	从指定的 `RangeElement` 开始，在元素的内容中搜索指定类型的后代。
`findText(searchPattern)`	`RangeElement`	使用正则表达式在元素内容中搜索指定的文本模式。
`findText(searchPattern, from)`	`RangeElement`	从给定搜索结果开始，在元素内容中搜索指定的文本模式。
`getAlignment()`	`HorizontalAlignment`	检索 `HorizontalAlignment`。
`getAttributes()`	`Object`	检索元素的属性。
`getChild(childIndex)`	`Element`	检索指定子索引位置的子元素。
`getChildIndex(child)`	`Integer`	检索指定子元素的子元素索引。
`getHeading()`	`ParagraphHeading`	检索 `ParagraphHeading`。
`getIndentEnd()`	`Number`	检索结束缩进，以点为单位。
`getIndentFirstLine()`	`Number`	检索首行缩进（以点为单位）。
`getIndentStart()`	`Number`	检索起始缩进。
`getLineSpacing()`	`Number`	检索行间距（以点为单位）。
`getLinkUrl()`	`String`	检索链接网址。
`getNextSibling()`	`Element`	检索元素的下一个同级元素。
`getNumChildren()`	`Integer`	检索子项的数量。
`getParent()`	`ContainerElement`	检索元素的父元素。
`getPositionedImage(id)`	`PositionedImage`	根据图片的 ID 获取 `PositionedImage`。
`getPositionedImages()`	`PositionedImage[]`	获取锚定到段落的所有 `PositionedImage` 对象。
`getPreviousSibling()`	`Element`	检索元素的上一个同级元素。
`getSpacingAfter()`	`Number`	检索元素后面的间距（以点为单位）。
`getSpacingBefore()`	`Number`	检索元素前面的间距（以点为单位）。
`getText()`	`String`	以文本字符串的形式检索元素的内容。
`getTextAlignment()`	`TextAlignment`	获取文本对齐方式。
`getType()`	`ElementType`	检索元素的 `ElementType`。
`insertHorizontalRule(childIndex)`	`HorizontalRule`	在指定索引处创建并插入 `HorizontalRule`。
`insertInlineImage(childIndex, image)`	`InlineImage`	在指定的索引处，从指定的图片 blob 创建并插入新的 `InlineImage`。
`insertInlineImage(childIndex, image)`	`InlineImage`	在指定的索引处插入给定的 `InlineImage`。
`insertPageBreak(childIndex)`	`PageBreak`	在指定索引处创建并插入新的 `PageBreak`。
`insertPageBreak(childIndex, pageBreak)`	`PageBreak`	在指定的索引处插入给定的 `PageBreak`。
`insertText(childIndex, text)`	`Text`	在指定索引处创建并插入新的文本元素。
`insertText(childIndex, text)`	`Text`	在指定索引处插入指定的 `Text` 元素，并附带指定的文本内容。
`isAtDocumentEnd()`	`Boolean`	确定元素是否位于 `Document` 的末尾。
`isLeftToRight()`	`Boolean`	检索从左到右的设置。
`merge()`	`Paragraph`	将元素与同一类型的上一个同级元素合并。
`removeChild(child)`	`Paragraph`	移除指定的子元素。
`removeFromParent()`	`Paragraph`	从其父元素中移除元素。
`removePositionedImage(id)`	`Boolean`	按图片 ID 移除 `PositionedImage`。
`replaceText(searchPattern, replacement)`	`Element`	使用正则表达式将给定文本模式的所有出现替换为给定的替换字符串。
`setAlignment(alignment)`	`Paragraph`	设置 `HorizontalAlignment`。
`setAttributes(attributes)`	`Paragraph`	设置元素的属性。
`setHeading(heading)`	`Paragraph`	设置 `ParagraphHeading`。
`setIndentEnd(indentEnd)`	`Paragraph`	设置末尾缩进，以点为单位。
`setIndentFirstLine(indentFirstLine)`	`Paragraph`	设置首行缩进（以点为单位）。
`setIndentStart(indentStart)`	`Paragraph`	设置起始缩进，以点为单位。
`setLeftToRight(leftToRight)`	`Paragraph`	设置从左到右的方向。
`setLineSpacing(multiplier)`	`Paragraph`	设置行间距，作为一个量，表示用于间距的行数。
`setLinkUrl(url)`	`Paragraph`	设置链接网址。
`setSpacingAfter(spacingAfter)`	`Paragraph`	设置元素后面的间距（以点为单位）。
`setSpacingBefore(spacingBefore)`	`Paragraph`	设置元素前面的间距（以点为单位）。
`setText(text)`	`void`	将段落的内容设置为文本。
`setTextAlignment(textAlignment)`	`Paragraph`	设置文本对齐方式。

`ParagraphHeading`

属性

属性	类型	说明
`NORMAL`	`Enum`	适用于普通文本的标题选项。
`HEADING1`	`Enum`	最高级别的标题选项。
`HEADING2`	`Enum`	第二个标题选项。
`HEADING3`	`Enum`	第三个标题选项
`HEADING4`	`Enum`	第四个标题选项。
`HEADING5`	`Enum`	第五个标题选项。
`HEADING6`	`Enum`	最低的标题选项。
`TITLE`	`Enum`	标题标题选项。
`SUBTITLE`	`Enum`	字幕标题选项。

`Person`

方法

方法	返回类型	简介
`copy()`	`Person`	返回当前元素的脱离式深层副本。
`getAttributes()`	`Object`	检索元素的属性。
`getEmail()`	`String`	返回用户的电子邮件地址。
`getName()`	`String`	返回人员的显示名称（如果已设置）。
`getNextSibling()`	`Element`	检索元素的下一个同级元素。
`getParent()`	`ContainerElement`	检索元素的父元素。
`getPreviousSibling()`	`Element`	检索元素的上一个同级元素。
`getType()`	`ElementType`	检索元素的 `ElementType`。
`isAtDocumentEnd()`	`Boolean`	确定元素是否位于 `Document` 的末尾。
`merge()`	`Person`	将元素与同一类型的上一个同级元素合并。
`removeFromParent()`	`Person`	从其父元素中移除元素。
`setAttributes(attributes)`	`Person`	设置元素的属性。

`Position`

方法

方法	返回类型	简介
`getElement()`	`Element`	获取包含此 `Position` 的元素。
`getOffset()`	`Integer`	获取此 `Position` 在包含它的元素中的相对位置。
`getSurroundingText()`	`Text`	创建一个人工 `Text` 元素，用于直接或通过一连串子元素表示包含 `Position` 的 `Paragraph` 或 `ListItem` 的文本和格式。
`getSurroundingTextOffset()`	`Integer`	获取 `getSurroundingText()` 返回的 `Text` 元素中此 `Position` 的偏移量。
`insertBookmark()`	`Bookmark`	在此 `Position` 中创建并插入新的 `Bookmark`。
`insertInlineImage(image)`	`InlineImage`	从指定的图片 blob 中创建并在此 `Position` 中插入新的 `InlineImage`。
`insertText(text)`	`Text`	在此 `Position` 中插入指定文本。

`PositionedImage`

方法

方法	返回类型	简介
`getAs(contentType)`	`Blob`	将此对象内的数据作为转换为指定内容类型的 blob 返回。
`getBlob()`	`Blob`	以 blob 的形式返回此对象内的数据。
`getHeight()`	`Integer`	检索图片的高度（以像素为单位）。
`getId()`	`String`	获取图片的 ID。
`getLayout()`	`PositionedLayout`	获取一个枚举值，表示图片的布局方式。
`getLeftOffset()`	`Number`	获取图片相对于段落左侧的偏移量（以点为单位）。
`getParagraph()`	`Paragraph`	获取图片锚定的 `Paragraph`。
`getTopOffset()`	`Number`	获取图片相对于段落顶部的偏移量（以点为单位）。
`getWidth()`	`Integer`	检索图片的宽度（以像素为单位）。
`setHeight(height)`	`PositionedImage`	设置图片的高度（以像素为单位）。
`setLayout(layout)`	`PositionedImage`	设置图片布局方式的定义。
`setLeftOffset(offset)`	`PositionedImage`	设置图片相对于段落左侧的偏移量（以点为单位）。
`setTopOffset(offset)`	`PositionedImage`	设置图片相对于段落顶部的偏移量（以点为单位）。
`setWidth(width)`	`PositionedImage`	设置图片的宽度（以像素为单位）。

`PositionedLayout`

属性

属性	类型	说明
`ABOVE_TEXT`	`Enum`	图片位于文字上方。
`BREAK_BOTH`	`Enum`	图片会将文本分隔到左侧和右侧。
`BREAK_LEFT`	`Enum`	图片会破坏左侧的文字。
`BREAK_RIGHT`	`Enum`	图片会破坏右侧的文本。
`WRAP_TEXT`	`Enum`	图片被文本换行。

`Range`

方法

方法	返回类型	简介
`getRangeElements()`	`RangeElement[]`	获取此 `Range` 中的所有元素，包括任何部分 `Text` 元素（例如，如果选择仅包含 `Text` 元素的一部分）。

`RangeBuilder`

方法

方法	返回类型	简介
`addElement(element)`	`RangeBuilder`	将整个 `Element` 添加到此 `RangeBuilder`。
`addElement(textElement, startOffset, endOffsetInclusive)`	`RangeBuilder`	向此 `RangeBuilder` 添加部分 `Text` 元素。
`addElementsBetween(startElement, endElementInclusive)`	`RangeBuilder`	将两个完整元素以及它们之间的所有元素添加到此 `RangeBuilder`。
`addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)`	`RangeBuilder`	将两个部分 `Text` 元素以及它们之间的所有元素添加到 `RangeBuilder`。
`addRange(range)`	`RangeBuilder`	将另一个 `Range` 的内容添加到此 `RangeBuilder`。
`build()`	`Range`	根据应用于构建器的设置构造 `Range`。
`getRangeElements()`	`RangeElement[]`	获取此 `Range` 中的所有元素，包括任何部分 `Text` 元素（例如，如果选择仅包含 `Text` 元素的一部分）。

`RangeElement`

方法

方法	返回类型	简介
`getElement()`	`Element`	获取与此 `RangeElement` 相对应的 `Element`。
`getEndOffsetInclusive()`	`Integer`	获取范围元素中部分范围的结束位置。
`getStartOffset()`	`Integer`	获取范围元素中部分范围的起始位置。
`isPartial()`	`Boolean`	确定此范围元素是涵盖整个元素，还是仅涵盖元素字符的部分选择。

`RichLink`

方法

方法	返回类型	简介
`copy()`	`RichLink`	返回当前元素的脱离式深层副本。
`getAttributes()`	`Object`	检索元素的属性。
`getMimeType()`	`String`	返回链接的 MIME 类型。如果内容是指向云端硬盘文件的链接，则可用；否则为 `null`。
`getNextSibling()`	`Element`	检索元素的下一个同级元素。
`getParent()`	`ContainerElement`	检索元素的父元素。
`getPreviousSibling()`	`Element`	检索元素的上一个同级元素。
`getTitle()`	`String`	返回链接的显示标题。
`getType()`	`ElementType`	检索元素的 `ElementType`。
`getUrl()`	`String`	返回资源的网址。
`isAtDocumentEnd()`	`Boolean`	确定元素是否位于 `Document` 的末尾。
`merge()`	`RichLink`	将元素与同一类型的上一个同级元素合并。
`removeFromParent()`	`RichLink`	从其父元素中移除元素。
`setAttributes(attributes)`	`RichLink`	设置元素的属性。

`Tab`

方法

方法	返回类型	简介
`asDocumentTab()`	`DocumentTab`	以 `DocumentTab` 的形式检索标签页内容。
`getChildTabs()`	`Tab[]`	检索嵌套在此标签页中的子标签页。
`getId()`	`String`	检索标签页的 ID。
`getIndex()`	`Integer`	检索父级中标签页的索引（从 0 开始）。
`getTitle()`	`String`	检索标签页的标题。
`getType()`	`TabType`	检索标签页的类型。

`TabType`

属性

属性	类型	说明
`DOCUMENT_TAB`	`Enum`	与 `DocumentTab` 对应的类型。

`Table`

方法

方法	返回类型	简介
`appendTableRow()`	`TableRow`	创建并附加新的 `TableRow`。
`appendTableRow(tableRow)`	`TableRow`	附加给定的 `TableRow`。
`clear()`	`Table`	清除元素的内容。
`copy()`	`Table`	返回当前元素的脱离式深层副本。
`editAsText()`	`Text`	获取当前元素的 `Text` 版本，以供修改。
`findElement(elementType)`	`RangeElement`	在元素的内容中搜索指定类型的后代。
`findElement(elementType, from)`	`RangeElement`	从指定的 `RangeElement` 开始，在元素的内容中搜索指定类型的后代。
`findText(searchPattern)`	`RangeElement`	使用正则表达式在元素内容中搜索指定的文本模式。
`findText(searchPattern, from)`	`RangeElement`	从给定搜索结果开始，在元素内容中搜索指定的文本模式。
`getAttributes()`	`Object`	检索元素的属性。
`getBorderColor()`	`String`	检索边框颜色。
`getBorderWidth()`	`Number`	检索边框宽度（以点为单位）。
`getCell(rowIndex, cellIndex)`	`TableCell`	检索指定行和单元格索引处的 `TableCell`。
`getChild(childIndex)`	`Element`	检索指定子索引位置的子元素。
`getChildIndex(child)`	`Integer`	检索指定子元素的子元素索引。
`getColumnWidth(columnIndex)`	`Number`	检索指定表格列的宽度（以点为单位）。
`getLinkUrl()`	`String`	检索链接网址。
`getNextSibling()`	`Element`	检索元素的下一个同级元素。
`getNumChildren()`	`Integer`	检索子项的数量。
`getNumRows()`	`Integer`	检索 `TableRows` 的数量。
`getParent()`	`ContainerElement`	检索元素的父元素。
`getPreviousSibling()`	`Element`	检索元素的上一个同级元素。
`getRow(rowIndex)`	`TableRow`	检索指定行索引处的 `TableRow`。
`getText()`	`String`	以文本字符串的形式检索元素的内容。
`getTextAlignment()`	`TextAlignment`	获取文本对齐方式。
`getType()`	`ElementType`	检索元素的 `ElementType`。
`insertTableRow(childIndex)`	`TableRow`	在指定索引处创建并插入新的 `TableRow`。
`insertTableRow(childIndex, tableRow)`	`TableRow`	在指定的索引处插入给定的 `TableRow`。
`isAtDocumentEnd()`	`Boolean`	确定元素是否位于 `Document` 的末尾。
`removeChild(child)`	`Table`	移除指定的子元素。
`removeFromParent()`	`Table`	从其父元素中移除元素。
`removeRow(rowIndex)`	`TableRow`	移除指定行索引处的 `TableRow`。
`replaceText(searchPattern, replacement)`	`Element`	使用正则表达式将给定文本模式的所有出现替换为给定的替换字符串。
`setAttributes(attributes)`	`Table`	设置元素的属性。
`setBorderColor(color)`	`Table`	设置边框颜色。
`setBorderWidth(width)`	`Table`	设置边框宽度（以磅为单位）。
`setColumnWidth(columnIndex, width)`	`Table`	设置指定列的宽度（以点为单位）。
`setLinkUrl(url)`	`Table`	设置链接网址。
`setTextAlignment(textAlignment)`	`Table`	设置文本对齐方式。

`TableCell`

方法

方法	返回类型	简介
`appendHorizontalRule()`	`HorizontalRule`	创建并附加新的 `HorizontalRule`。
`appendImage(image)`	`InlineImage`	从指定的图片 blob 创建并附加新的 `InlineImage`。
`appendImage(image)`	`InlineImage`	附加给定的 `InlineImage`。
`appendListItem(listItem)`	`ListItem`	附加给定的 `ListItem`。
`appendListItem(text)`	`ListItem`	创建并附加新的 `ListItem`。
`appendParagraph(paragraph)`	`Paragraph`	附加给定的 `Paragraph`。
`appendParagraph(text)`	`Paragraph`	创建并附加新的 `Paragraph`。
`appendTable()`	`Table`	创建并附加新的 `Table`。
`appendTable(cells)`	`Table`	附加一个包含指定单元格的新 `Table`。
`appendTable(table)`	`Table`	附加给定的 `Table`。
`clear()`	`TableCell`	清除元素的内容。
`copy()`	`TableCell`	返回当前元素的脱离式深层副本。
`editAsText()`	`Text`	获取当前元素的 `Text` 版本，以供修改。
`findElement(elementType)`	`RangeElement`	在元素的内容中搜索指定类型的后代。
`findElement(elementType, from)`	`RangeElement`	从指定的 `RangeElement` 开始，在元素的内容中搜索指定类型的后代。
`findText(searchPattern)`	`RangeElement`	使用正则表达式在元素内容中搜索指定的文本模式。
`findText(searchPattern, from)`	`RangeElement`	从给定搜索结果开始，在元素内容中搜索指定的文本模式。
`getAttributes()`	`Object`	检索元素的属性。
`getBackgroundColor()`	`String`	检索背景颜色。
`getChild(childIndex)`	`Element`	检索指定子索引位置的子元素。
`getChildIndex(child)`	`Integer`	检索指定子元素的子元素索引。
`getColSpan()`	`Integer`	检索列跨度，即此单元格跨越的表格单元格的列数。
`getLinkUrl()`	`String`	检索链接网址。
`getNextSibling()`	`Element`	检索元素的下一个同级元素。
`getNumChildren()`	`Integer`	检索子项的数量。
`getPaddingBottom()`	`Number`	检索底部内边距（以点为单位）。
`getPaddingLeft()`	`Number`	检索左内边距（以点为单位）。
`getPaddingRight()`	`Number`	检索右内边距（以点为单位）。
`getPaddingTop()`	`Number`	检索顶部内边距（以点为单位）。
`getParent()`	`ContainerElement`	检索元素的父元素。
`getParentRow()`	`TableRow`	检索包含当前 `TableCell` 的 `TableRow`。
`getParentTable()`	`Table`	检索包含当前 `TableCell` 的 `Table`。
`getPreviousSibling()`	`Element`	检索元素的上一个同级元素。
`getRowSpan()`	`Integer`	检索行跨度，即此单元格跨越的表格单元格的行数。
`getText()`	`String`	以文本字符串的形式检索元素的内容。
`getTextAlignment()`	`TextAlignment`	获取文本对齐方式。
`getType()`	`ElementType`	检索元素的 `ElementType`。
`getVerticalAlignment()`	`VerticalAlignment`	检索 `VerticalAlignment`。
`getWidth()`	`Number`	检索包含单元格的列的宽度（以点为单位）。
`insertHorizontalRule(childIndex)`	`HorizontalRule`	在指定索引处创建并插入新的 `HorizontalRule`。
`insertImage(childIndex, image)`	`InlineImage`	在指定位置从指定图片 blob 创建并插入 `InlineImage`。
`insertImage(childIndex, image)`	`InlineImage`	在指定的索引处插入给定的 `InlineImage`。
`insertListItem(childIndex, listItem)`	`ListItem`	在指定的索引处插入给定的 `ListItem`。
`insertListItem(childIndex, text)`	`ListItem`	在指定索引处创建并插入新的 `ListItem`。
`insertParagraph(childIndex, paragraph)`	`Paragraph`	在指定的索引处插入给定的 `Paragraph`。
`insertParagraph(childIndex, text)`	`Paragraph`	在指定索引处创建并插入新的 `Paragraph`。
`insertTable(childIndex)`	`Table`	在指定索引处创建并插入新的 `Table`。
`insertTable(childIndex, cells)`	`Table`	在指定索引处创建并插入包含指定单元格的新 `Table`。
`insertTable(childIndex, table)`	`Table`	在指定的索引处插入给定的 `Table`。
`isAtDocumentEnd()`	`Boolean`	确定元素是否位于 `Document` 的末尾。
`merge()`	`TableCell`	将元素与同一类型的上一个同级元素合并。
`removeChild(child)`	`TableCell`	移除指定的子元素。
`removeFromParent()`	`TableCell`	从其父元素中移除元素。
`replaceText(searchPattern, replacement)`	`Element`	使用正则表达式将给定文本模式的所有出现替换为给定的替换字符串。
`setAttributes(attributes)`	`TableCell`	设置元素的属性。
`setBackgroundColor(color)`	`TableCell`	设置背景颜色。
`setLinkUrl(url)`	`TableCell`	设置链接网址。
`setPaddingBottom(paddingBottom)`	`TableCell`	设置底部内边距（以点为单位）。
`setPaddingLeft(paddingLeft)`	`TableCell`	设置左侧内边距（以点为单位）。
`setPaddingRight(paddingRight)`	`TableCell`	设置右内边距（以点为单位）。
`setPaddingTop(paddingTop)`	`TableCell`	设置上内边距（以点为单位）。
`setText(text)`	`TableCell`	将内容设置为纯文本。
`setTextAlignment(textAlignment)`	`TableCell`	设置文本对齐方式。
`setVerticalAlignment(alignment)`	`TableCell`	设置垂直对齐方式。
`setWidth(width)`	`TableCell`	设置包含当前单元格的列的宽度（以点为单位）。

`TableOfContents`

方法

方法	返回类型	简介
`clear()`	`TableOfContents`	清除元素的内容。
`copy()`	`TableOfContents`	返回当前元素的脱离式深层副本。
`editAsText()`	`Text`	获取当前元素的 `Text` 版本，以供修改。
`findElement(elementType)`	`RangeElement`	在元素的内容中搜索指定类型的后代。
`findElement(elementType, from)`	`RangeElement`	从指定的 `RangeElement` 开始，在元素的内容中搜索指定类型的后代。
`findText(searchPattern)`	`RangeElement`	使用正则表达式在元素内容中搜索指定的文本模式。
`findText(searchPattern, from)`	`RangeElement`	从给定搜索结果开始，在元素内容中搜索指定的文本模式。
`getAttributes()`	`Object`	检索元素的属性。
`getChild(childIndex)`	`Element`	检索指定子索引位置的子元素。
`getChildIndex(child)`	`Integer`	检索指定子元素的子元素索引。
`getLinkUrl()`	`String`	检索链接网址。
`getNextSibling()`	`Element`	检索元素的下一个同级元素。
`getNumChildren()`	`Integer`	检索子项的数量。
`getParent()`	`ContainerElement`	检索元素的父元素。
`getPreviousSibling()`	`Element`	检索元素的上一个同级元素。
`getText()`	`String`	以文本字符串的形式检索元素的内容。
`getTextAlignment()`	`TextAlignment`	获取文本对齐方式。
`getType()`	`ElementType`	检索元素的 `ElementType`。
`isAtDocumentEnd()`	`Boolean`	确定元素是否位于 `Document` 的末尾。
`removeFromParent()`	`TableOfContents`	从其父元素中移除元素。
`replaceText(searchPattern, replacement)`	`Element`	使用正则表达式将给定文本模式的所有出现替换为给定的替换字符串。
`setAttributes(attributes)`	`TableOfContents`	设置元素的属性。
`setLinkUrl(url)`	`TableOfContents`	设置链接网址。
`setTextAlignment(textAlignment)`	`TableOfContents`	设置文本对齐方式。

`TableRow`

方法

方法	返回类型	简介
`appendTableCell()`	`TableCell`	创建并附加新的 `TableCell`。
`appendTableCell(textContents)`	`TableCell`	附加包含指定文本的给定 `TableCell`。
`appendTableCell(tableCell)`	`TableCell`	附加给定的 `TableCell`。
`clear()`	`TableRow`	清除元素的内容。
`copy()`	`TableRow`	返回当前元素的脱离式深层副本。
`editAsText()`	`Text`	获取当前元素的 `Text` 版本，以供修改。
`findElement(elementType)`	`RangeElement`	在元素的内容中搜索指定类型的后代。
`findElement(elementType, from)`	`RangeElement`	从指定的 `RangeElement` 开始，在元素的内容中搜索指定类型的后代。
`findText(searchPattern)`	`RangeElement`	使用正则表达式在元素内容中搜索指定的文本模式。
`findText(searchPattern, from)`	`RangeElement`	从给定搜索结果开始，在元素内容中搜索指定的文本模式。
`getAttributes()`	`Object`	检索元素的属性。
`getCell(cellIndex)`	`TableCell`	检索指定单元格索引处的 `TableCell`。
`getChild(childIndex)`	`Element`	检索指定子索引位置的子元素。
`getChildIndex(child)`	`Integer`	检索指定子元素的子元素索引。
`getLinkUrl()`	`String`	检索链接网址。
`getMinimumHeight()`	`Number`	检索高度下限（以点为单位）。
`getNextSibling()`	`Element`	检索元素的下一个同级元素。
`getNumCells()`	`Integer`	检索行中的单元格数。
`getNumChildren()`	`Integer`	检索子项的数量。
`getParent()`	`ContainerElement`	检索元素的父元素。
`getParentTable()`	`Table`	检索包含当前行的 `Table`。
`getPreviousSibling()`	`Element`	检索元素的上一个同级元素。
`getText()`	`String`	以文本字符串的形式检索元素的内容。
`getTextAlignment()`	`TextAlignment`	获取文本对齐方式。
`getType()`	`ElementType`	检索元素的 `ElementType`。
`insertTableCell(childIndex)`	`TableCell`	在指定索引处创建并插入新的 `TableCell`。
`insertTableCell(childIndex, textContents)`	`TableCell`	在指定的索引处插入包含给定文本的给定 `TableCell`。
`insertTableCell(childIndex, tableCell)`	`TableCell`	在指定的索引处插入给定的 `TableCell`。
`isAtDocumentEnd()`	`Boolean`	确定元素是否位于 `Document` 的末尾。
`merge()`	`TableRow`	将元素与同一类型的上一个同级元素合并。
`removeCell(cellIndex)`	`TableCell`	移除指定单元格索引处的 `TableCell`。
`removeChild(child)`	`TableRow`	移除指定的子元素。
`removeFromParent()`	`TableRow`	从其父元素中移除元素。
`replaceText(searchPattern, replacement)`	`Element`	使用正则表达式将给定文本模式的所有出现替换为给定的替换字符串。
`setAttributes(attributes)`	`TableRow`	设置元素的属性。
`setLinkUrl(url)`	`TableRow`	设置链接网址。
`setMinimumHeight(minHeight)`	`TableRow`	设置高度下限（以点为单位）。
`setTextAlignment(textAlignment)`	`TableRow`	设置文本对齐方式。

`Text`

方法

方法	返回类型	简介
`appendText(text)`	`Text`	将指定文本添加到此文本区域的末尾。
`copy()`	`Text`	返回当前元素的脱离式深层副本。
`deleteText(startOffset, endOffsetInclusive)`	`Text`	删除一段文本。
`editAsText()`	`Text`	获取当前元素的 `Text` 版本，以供修改。
`findText(searchPattern)`	`RangeElement`	使用正则表达式在元素内容中搜索指定的文本模式。
`findText(searchPattern, from)`	`RangeElement`	从给定搜索结果开始，在元素内容中搜索指定的文本模式。
`getAttributes()`	`Object`	检索元素的属性。
`getAttributes(offset)`	`Object`	检索指定字符偏移处的属性。
`getBackgroundColor()`	`String`	检索背景颜色设置。
`getBackgroundColor(offset)`	`String`	检索指定字符偏移处的背景颜色。
`getFontFamily()`	`String`	检索字体系列设置。
`getFontFamily(offset)`	`String`	检索指定字符偏移处的字体系列。
`getFontSize()`	`Number`	检索字体大小设置。
`getFontSize(offset)`	`Number`	检索指定字符偏移处的字体大小。
`getForegroundColor()`	`String`	检索前景颜色设置。
`getForegroundColor(offset)`	`String`	检索指定字符偏移处的前景色。
`getLinkUrl()`	`String`	检索链接网址。
`getLinkUrl(offset)`	`String`	检索指定字符偏移处的链接网址。
`getNextSibling()`	`Element`	检索元素的下一个同级元素。
`getParent()`	`ContainerElement`	检索元素的父元素。
`getPreviousSibling()`	`Element`	检索元素的上一个同级元素。
`getText()`	`String`	以文本字符串的形式检索元素的内容。
`getTextAlignment()`	`TextAlignment`	获取文本对齐方式。
`getTextAlignment(offset)`	`TextAlignment`	获取单个字符的文本对齐方式。
`getTextAttributeIndices()`	`Integer[]`	检索与不同的文本格式化运行的开始部分对应的文本索引集。
`getType()`	`ElementType`	检索元素的 `ElementType`。
`insertText(offset, text)`	`Text`	在指定的字符偏移量处插入指定文本。
`isAtDocumentEnd()`	`Boolean`	确定元素是否位于 `Document` 的末尾。
`isBold()`	`Boolean`	检索粗体设置。
`isBold(offset)`	`Boolean`	检索指定字符偏移处的粗体设置。
`isItalic()`	`Boolean`	检索斜体设置。
`isItalic(offset)`	`Boolean`	检索指定字符偏移处的斜体设置。
`isStrikethrough()`	`Boolean`	检索删除线设置。
`isStrikethrough(offset)`	`Boolean`	检索指定字符偏移处的删除线设置。
`isUnderline()`	`Boolean`	检索下划线设置。
`isUnderline(offset)`	`Boolean`	检索指定字符偏移处的下划线设置。
`merge()`	`Text`	将元素与同一类型的上一个同级元素合并。
`removeFromParent()`	`Text`	从其父元素中移除元素。
`replaceText(searchPattern, replacement)`	`Element`	使用正则表达式将给定文本模式的所有出现替换为给定的替换字符串。
`setAttributes(startOffset, endOffsetInclusive, attributes)`	`Text`	将指定的属性应用于给定的字符范围。
`setAttributes(attributes)`	`Text`	设置元素的属性。
`setBackgroundColor(startOffset, endOffsetInclusive, color)`	`Text`	设置指定字符范围的背景颜色。
`setBackgroundColor(color)`	`Text`	设置背景颜色。
`setBold(bold)`	`Text`	设置粗体设置。
`setBold(startOffset, endOffsetInclusive, bold)`	`Text`	为指定的字符范围设置粗体设置。
`setFontFamily(startOffset, endOffsetInclusive, fontFamilyName)`	`Text`	为指定的字符范围设置字体系列。
`setFontFamily(fontFamilyName)`	`Text`	设置字体系列。
`setFontSize(startOffset, endOffsetInclusive, size)`	`Text`	设置指定字符范围的字体大小。
`setFontSize(size)`	`Text`	设置字体大小。
`setForegroundColor(startOffset, endOffsetInclusive, color)`	`Text`	设置指定字符范围的前景颜色。
`setForegroundColor(color)`	`Text`	设置前景颜色。
`setItalic(italic)`	`Text`	设置斜体设置。
`setItalic(startOffset, endOffsetInclusive, italic)`	`Text`	为指定的字符范围设置斜体设置。
`setLinkUrl(startOffset, endOffsetInclusive, url)`	`Text`	设置指定字符范围的链接网址。
`setLinkUrl(url)`	`Text`	设置链接网址。
`setStrikethrough(strikethrough)`	`Text`	设置删除线设置。
`setStrikethrough(startOffset, endOffsetInclusive, strikethrough)`	`Text`	为指定的字符范围设置删除线设置。
`setText(text)`	`Text`	设置文本内容。
`setTextAlignment(startOffset, endOffsetInclusive, textAlignment)`	`Text`	为给定字符范围设置文本对齐方式。
`setTextAlignment(textAlignment)`	`Text`	设置文本对齐方式。
`setUnderline(underline)`	`Text`	设置下划线设置。
`setUnderline(startOffset, endOffsetInclusive, underline)`	`Text`	为指定的字符范围设置下划线设置。

`TextAlignment`

属性

属性	类型	说明
`NORMAL`	`Enum`	普通文本对齐方式。
`SUPERSCRIPT`	`Enum`	上标文本对齐方式。
`SUBSCRIPT`	`Enum`	下标文本对齐方式。

`UnsupportedElement`

方法

方法	返回类型	简介
`copy()`	`UnsupportedElement`	返回当前元素的脱离式深层副本。
`getAttributes()`	`Object`	检索元素的属性。
`getNextSibling()`	`Element`	检索元素的下一个同级元素。
`getParent()`	`ContainerElement`	检索元素的父元素。
`getPreviousSibling()`	`Element`	检索元素的上一个同级元素。
`getType()`	`ElementType`	检索元素的 `ElementType`。
`isAtDocumentEnd()`	`Boolean`	确定元素是否位于 `Document` 的末尾。
`merge()`	`UnsupportedElement`	将元素与同一类型的上一个同级元素合并。
`removeFromParent()`	`UnsupportedElement`	从其父元素中移除元素。
`setAttributes(attributes)`	`UnsupportedElement`	设置元素的属性。

`VerticalAlignment`

属性

属性	类型	说明
`BOTTOM`	`Enum`	底部对齐选项。
`CENTER`	`Enum`	居中对齐选项。
`TOP`	`Enum`	顶部对齐选项。

Document Service 使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

类

属性

方法

方法

方法

方法

方法

属性

方法

方法

方法

属性

方法

方法

方法

方法

方法

方法

方法

属性

方法

属性

方法

方法

方法

方法

方法

方法

方法

属性

方法

方法

方法

属性

方法

方法

方法

方法

方法

属性

方法

方法

方法

方法

方法

属性

方法

属性

Document Service
使用集合让一切井井有条根据您的偏好保存内容并对其进行分类。