此页面由 Cloud Translation API 翻译。

Class Body

Google 文档中标签页的内容。Body 可能包含 ListItem、Paragraph、Table 和 TableOfContents 元素。如需详细了解文档结构，请参阅扩展 Google 文档指南。

Body 通常包含标签页的完整内容，但 HeaderSection、FooterSection 和任何 FootnoteSection 元素除外。

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Append a paragraph and a page break to the tab's body section directly.
body.appendParagraph('A paragraph.');
body.appendPageBreak();

方法

方法	返回类型	简介
`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`	附加一个新 `Table`，其中包含每个指定字符串值的 `TableCell`。
`appendTable(table)`	`Table`	附加给定的 `Table`。
`clear()`	`Body`	清除元素的内容。
`copy()`	`Body`	返回当前元素的已分离深层副本。
`editAsText()`	`Text`	获取当前元素的 `Text` 版本以进行修改。
`findElement(elementType)`	`RangeElement\|null`	在元素的内容中搜索指定类型的后代。
`findElement(elementType, from)`	`RangeElement\|null`	从指定的 `RangeElement` 开始，在元素的内容中搜索指定类型的后代。
`findText(searchPattern)`	`RangeElement\|null`	使用正则表达式在元素的内容中搜索指定的文本模式。
`findText(searchPattern, from)`	`RangeElement\|null`	从给定的搜索结果开始，在元素的内容中搜索指定的文本模式。
`getAttributes()`	`Object`	检索元素的属性。
`getChild(childIndex)`	`Element`	检索指定子索引处的子元素。
`getChildIndex(child)`	`Integer`	检索指定子元素的子级索引。
`getHeadingAttributes(paragraphHeading)`	`Object`	检索所提供 `ParagraphHeading` 的属性集。
`getImages()`	`InlineImage[]\|null`	检索相应部分中包含的所有 `InlineImages`。
`getListItems()`	`ListItem[]\|null`	检索相应部分中包含的所有 `ListItems`。
`getMarginBottom()`	`Number\|null`	检索下边距（以磅为单位）。
`getMarginLeft()`	`Number\|null`	检索左边距（以磅为单位）。
`getMarginRight()`	`Number\|null`	检索右边距。
`getMarginTop()`	`Number\|null`	检索上边距。
`getNumChildren()`	`Integer`	检索子项的数量。
`getPageHeight()`	`Number\|null`	检索页面高度（以磅为单位）。
`getPageWidth()`	`Number\|null`	检索页面宽度（以点为单位）。
`getParagraphs()`	`Paragraph[]\|null`	检索部分中包含的所有 `Paragraphs`（包括 `ListItems`）。
`getParent()`	`ContainerElement\|null`	检索元素的父元素。
`getTables()`	`Table[]\|null`	检索相应部分中包含的所有 `Tables`。
`getText()`	`String`	以文本字符串形式检索元素的内容。
`getTextAlignment()`	`TextAlignment\|null`	获取文本对齐方式。
`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`	设置文本对齐方式。

已弃用的方法

方法	返回类型	简介
`getFootnotes()`	`Footnote[]\|null`	检索相应部分中包含的所有 `Footnotes`。
`getLinkUrl()`	`String\|null`	检索链接网址。
`getNextSibling()`	`Element\|null`	检索元素的下一个同级元素。
`getPreviousSibling()`	`Element\|null`	检索元素的前一个同级元素。
`isAtDocumentEnd()`	`Boolean`	确定元素是否位于 `Document` 的末尾。
`setLinkUrl(url)`	`Body`	设置链接网址。

详细文档

`appendHorizontalRule()`

创建并附加新的 HorizontalRule。

HorizontalRule 将包含在新的 Paragraph 中。

HorizontalRule - 新的水平线。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`appendImage(image)`

根据指定的图片 blob 创建并附加新的 InlineImage。

图片将包含在新的 Paragraph 中。

参数

名称	类型	说明
`image`	`BlobSource`	图片数据。

InlineImage - 附加的图片。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`appendImage(image)`

附加给定的 InlineImage。

InlineImage 将包含在新的 Paragraph 中。

在附加现有 InlineImage 的副本时，使用此版本的 appendImage。

参数

名称	类型	说明
`image`	`InlineImage`	图片数据。

InlineImage - 附加的图片。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`appendListItem(listItem)`

附加给定的 ListItem。

在附加现有 ListItem 的副本时，使用此版本的 appendListItem。

参数

名称	类型	说明
`listItem`	`ListItem`	要附加的列表项。

ListItem - 附加的列表项。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`appendListItem(text)`

创建并附加包含指定文本内容的新 ListItem。

连续的列表项会作为同一列表的一部分添加。

参数

名称	类型	说明
`text`	`String`	相应列表项的文本内容。

ListItem - 新列表项。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`appendPageBreak()`

创建并附加新的 PageBreak。

PageBreak 将包含在新的 Paragraph 中。

PageBreak - 新的分页符。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`appendPageBreak(pageBreak)`

附加给定的 PageBreak。

PageBreak 将包含在新的 Paragraph 中。

在附加现有 PageBreak 的副本时，使用此版本的 appendPageBreak。

参数

名称	类型	说明
`pageBreak`	`PageBreak`	要附加的分页符。

PageBreak - 附加的分页符。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`appendParagraph(paragraph)`

附加给定的 Paragraph。

在附加现有 Paragraph 的副本时，使用此版本的 appendParagraph。

参数

名称	类型	说明
`paragraph`	`Paragraph`	要附加的段落。

Paragraph - 附加的段落。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`appendParagraph(text)`

创建并附加包含指定文本内容的新 Paragraph。

参数

名称	类型	说明
`text`	`String`	段落的文本内容。

Paragraph - 新段落。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`appendTable()`

创建并附加新的 Table。

此方法还会向表格后附加一个空段落，因为 Google 文档不能以表格结尾。

Table - 新表。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`appendTable(cells)`

附加一个新 Table，其中包含每个指定字符串值的 TableCell。

此方法还会向表格后附加一个空段落，因为 Google 文档不能以表格结尾。

参数

名称	类型	说明
`cells`	`String[][]`	要添加到新表格的表格单元格的文本内容。

Table - 追加的表。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`appendTable(table)`

附加给定的 Table。

在附加现有 Table 的副本时，请使用此版本的 appendTable。此方法还会向表格后附加一个空段落，因为 Google 文档不能以表格结尾。

参数

名称	类型	说明
`table`	`Table`	要附加的表。

Table - 追加的表。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`clear()`

清除元素的内容。

Body - 当前元素。

`copy()`

返回当前元素的已分离深层副本。

元素中包含的所有子元素也会被复制。新元素没有父元素。

Body - 新文案。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`editAsText()`

获取当前元素的 Text 版本以进行修改。

使用 editAsText 将元素内容作为富文本进行操作。editAsText 模式会忽略非文本元素（例如 InlineImage 和 HorizontalRule）。

完全包含在已删除文本范围内的子元素会从相应元素中移除。

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Insert two paragraphs separated by a paragraph containing an
// horizontal rule.
body.insertParagraph(0, 'An editAsText sample.');
body.insertHorizontalRule(0);
body.insertParagraph(0, 'An example.');

// Delete " sample.\n\n An" removing the horizontal rule in the process.
body.editAsText().deleteText(14, 25);

Text - 当前元素的文本版本

`findElement(elementType)`

在元素的内容中搜索指定类型的后代。

参数

名称	类型	说明
`elementType`	`ElementType`	要搜索的元素类型。

RangeElement|null - 一种搜索结果，用于指示搜索元素的位置。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`findElement(elementType, from)`

从指定的 RangeElement 开始，在元素的内容中搜索指定类型的后代。

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Define the search parameters.

let searchResult = null;

// Search until the paragraph is found.
while (
    (searchResult = body.findElement(
         DocumentApp.ElementType.PARAGRAPH,
         searchResult,
         ))) {
  const par = searchResult.getElement().asParagraph();
  if (par.getHeading() === DocumentApp.ParagraphHeading.HEADING1) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    break;
  }
}

参数

名称	类型	说明
`elementType`	`ElementType`	要搜索的元素类型。
`from`	`RangeElement`	要从中搜索的搜索结果。

RangeElement|null - 一种搜索结果，用于指示搜索元素的下一个位置。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`findText(searchPattern)`

使用正则表达式在元素的内容中搜索指定的文本模式。

部分 JavaScript 正则表达式功能不受完全支持，例如捕获组和模式修饰符。

系统会针对当前元素中包含的每个文本块独立匹配所提供的正则表达式模式。

参数

名称	类型	说明
`searchPattern`	`String`	要搜索的模式

RangeElement|null - 指示搜索文本位置的搜索结果，如果没有匹配项，则为 null

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`findText(searchPattern, from)`

从给定的搜索结果开始，在元素的内容中搜索指定的文本模式。

部分 JavaScript 正则表达式功能不受完全支持，例如捕获组和模式修饰符。

系统会针对当前元素中包含的每个文本块独立匹配所提供的正则表达式模式。

参数

名称	类型	说明
`searchPattern`	`String`	要搜索的模式
`from`	`RangeElement`	要开始搜索的搜索结果

RangeElement|null - 指示搜索文本的下一个位置的搜索结果，如果没有匹配项，则为 null

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getAttributes()`

检索元素的属性。

结果是一个对象，其中包含每个有效元素属性的属性，每个属性名称都对应于 DocumentApp.Attribute 枚举中的一个项。

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Append a styled paragraph.
const par = body.appendParagraph('A bold, italicized paragraph.');
par.setBold(true);
par.setItalic(true);

// Retrieve the paragraph's attributes.
const atts = par.getAttributes();

// Log the paragraph attributes.
for (const att in atts) {
  Logger.log(`${att}:${atts[att]}`);
}

Object - 元素的属性。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getChild(childIndex)`

检索指定子索引处的子元素。

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Obtain the first element in the tab.
const firstChild = body.getChild(0);

// If it's a paragraph, set its contents.
if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) {
  firstChild.asParagraph().setText('This is the first paragraph.');
}

参数

名称	类型	说明
`childIndex`	`Integer`	要检索的子元素的索引。

Element - 指定索引处的子元素。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getChildIndex(child)`

检索指定子元素的子级索引。

参数

名称	类型	说明
`child`	`Element`	要检索其索引的子元素。

Integer - 子索引。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getHeadingAttributes(paragraphHeading)`

检索所提供 ParagraphHeading 的属性集。

参数

名称	类型	说明
`paragraphHeading`	`ParagraphHeading`	应检索其属性的标题。

Object - 属性及其当前值的映射。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getImages()`

检索相应部分中包含的所有 InlineImages。

InlineImage[]|null - 版块图片。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getListItems()`

检索相应部分中包含的所有 ListItems。

ListItem[]|null - 版块列表项。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getMarginBottom()`

检索下边距（以磅为单位）。

Number|null - 下边距（以点为单位）。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getMarginLeft()`

检索左边距（以磅为单位）。

Number|null - 左边距（以磅为单位）。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getMarginRight()`

检索右边距。

Number|null - 右边距（以点为单位）。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getMarginTop()`

检索上边距。

Number|null - 上边距（以磅为单位）。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getNumChildren()`

检索子项的数量。

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Log the number of elements in the tab.
Logger.log(`There are ${body.getNumChildren()} elements in the tab's body.`);

Integer - 子项数量。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getPageHeight()`

检索页面高度（以磅为单位）。

Number|null - 页面高度（以点为单位）。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getPageWidth()`

检索页面宽度（以点为单位）。

Number|null - 页面宽度，以磅为单位。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getParagraphs()`

检索部分中包含的所有 Paragraphs（包括 ListItems）。

Paragraph[]|null - 部分段落。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getParent()`

检索元素的父元素。

父元素包含当前元素。

ContainerElement|null - 父元素。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getTables()`

检索相应部分中包含的所有 Tables。

Table[]|null - 部分表格。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getText()`

以文本字符串形式检索元素的内容。

String - 元素的内容（以文本字符串形式表示）

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getTextAlignment()`

获取文本对齐方式。可用的对齐类型包括 DocumentApp.TextAlignment.NORMAL、DocumentApp.TextAlignment.SUBSCRIPT 和 DocumentApp.TextAlignment.SUPERSCRIPT。

TextAlignment|null - 文本对齐类型，如果文本包含多种文本对齐类型或从未设置过文本对齐方式，则为 null

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getType()`

检索元素的 ElementType。

使用 getType() 确定给定元素的确切类型。

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Obtain the first element in the active tab's body.

const firstChild = body.getChild(0);

// Use getType() to determine the element's type.
if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) {
  Logger.log('The first element is a paragraph.');
} else {
  Logger.log('The first element is not a paragraph.');
}

ElementType - 元素类型。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`insertHorizontalRule(childIndex)`

在指定索引处创建并插入新的 HorizontalRule。

HorizontalRule 将包含在新的 Paragraph 中。

参数

名称	类型	说明
`childIndex`	`Integer`	要插入元素的索引。

HorizontalRule - 新的水平线。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`insertImage(childIndex, image)`

在指定索引处，根据指定的图片 blob 创建并插入 InlineImage。

参数

名称	类型	说明
`childIndex`	`Integer`	要插入元素的索引。
`image`	`BlobSource`	图片数据。

InlineImage - 插入的内嵌图片。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`insertImage(childIndex, image)`

在指定索引处插入给定的 InlineImage。

图片将包含在新的 Paragraph 中。

参数

名称	类型	说明
`childIndex`	`Integer`	要插入元素的索引。
`image`	`InlineImage`	要插入的图片。

InlineImage - 插入的内嵌图片。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`insertListItem(childIndex, listItem)`

在指定索引处插入给定的 ListItem。

参数

名称	类型	说明
`childIndex`	`Integer`	要插入的索引。
`listItem`	`ListItem`	要插入的列表项。

ListItem - 插入的列表项。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`insertListItem(childIndex, text)`

在指定索引处创建并插入新的 ListItem，其中包含指定的文本内容。

参数

名称	类型	说明
`childIndex`	`Integer`	要插入的索引。
`text`	`String`	相应列表项的文本内容。

ListItem - 新列表项。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`insertPageBreak(childIndex)`

在指定索引处创建并插入新的 PageBreak。

PageBreak 将包含在新的 Paragraph 中。

参数

名称	类型	说明
`childIndex`	`Integer`	要插入元素的索引。

PageBreak - 新的分页符。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`insertPageBreak(childIndex, pageBreak)`

在指定索引处插入给定的 PageBreak。

PageBreak 将包含在新的 Paragraph 中。

参数

名称	类型	说明
`childIndex`	`Integer`	要插入元素的索引。
`pageBreak`	`PageBreak`	要插入的分页符。

PageBreak - 插入的分页符。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`insertParagraph(childIndex, paragraph)`

在指定索引处插入给定的 Paragraph。

参数

名称	类型	说明
`childIndex`	`Integer`	要插入的索引。
`paragraph`	`Paragraph`	要插入的段落。

Paragraph - 插入的段落。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`insertParagraph(childIndex, text)`

在指定索引处创建并插入新的 Paragraph，其中包含指定的文本内容。

参数

名称	类型	说明
`childIndex`	`Integer`	要插入的索引。
`text`	`String`	段落的文本内容。

Paragraph - 新段落。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`insertTable(childIndex)`

在指定索引处创建并插入新的 Table。

参数

名称	类型	说明
`childIndex`	`Integer`	要插入的索引。

Table - 新表。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`insertTable(childIndex, cells)`

在指定索引处创建并插入包含指定单元格的新 Table。

参数

名称	类型	说明
`childIndex`	`Integer`	要插入的索引。
`cells`	`String[][]`	要添加到新表格的表格单元格的文本内容。

Table - 新表。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`insertTable(childIndex, table)`

在指定索引处插入给定的 Table。

参数

名称	类型	说明
`childIndex`	`Integer`	要插入的索引。
`table`	`Table`	要插入的表格。

Table - 插入的表格。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`removeChild(child)`

移除指定的子元素。

参数

名称	类型	说明
`child`	`Element`	要移除的子元素。

Body - 当前元素。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`replaceText(searchPattern, replacement)`

使用正则表达式将指定文本模式的所有匹配项替换为指定的替换字符串。

搜索模式以字符串形式传递，而不是以 JavaScript 正则表达式对象形式传递。因此，您需要对模式中的所有反斜杠进行转义。

此方法使用 Google 的 RE2 正则表达式库，该库限制了支持的语法。

系统会根据所提供的正则表达式模式，单独匹配当前元素中包含的每个文本块。

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Clear the text surrounding "Apps Script", with or without text.
body.replaceText('^.*Apps ?Script.*$', 'Apps Script');

参数

名称	类型	说明
`searchPattern`	`String`	要搜索的正则表达式模式
`replacement`	`String`	用作替换项的文本

Element - 当前元素

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setAttributes(attributes)`

设置元素的属性。

指定的 attributes 参数必须是一个对象，其中每个属性名称都是 DocumentApp.Attribute 枚举中的一个项，每个属性值都是要应用的新值。

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Define a custom paragraph style.
const style = {};
style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] =
    DocumentApp.HorizontalAlignment.RIGHT;
style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri';
style[DocumentApp.Attribute.FONT_SIZE] = 18;
style[DocumentApp.Attribute.BOLD] = true;

// Append a plain paragraph.
const par = body.appendParagraph('A paragraph with custom style.');

// Apply the custom style.
par.setAttributes(style);

参数

名称	类型	说明
`attributes`	`Object`	元素的属性。

Body - 当前元素。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setHeadingAttributes(paragraphHeading, attributes)`

为提供的 ParagraphHeading 设置属性。

参数

名称	类型	说明
`paragraphHeading`	`ParagraphHeading`	应设置属性的标题。
`attributes`	`Object`	属性及其要设置的值的映射。

Body - 当前元素。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setMarginBottom(marginBottom)`

设置下边距（以磅为单位）。

参数

名称	类型	说明
`marginBottom`	`Number`	下边距（以磅为单位）。

Body - 当前元素。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setMarginLeft(marginLeft)`

设置左边距（以磅为单位）。

参数

名称	类型	说明
`marginLeft`	`Number`	左边距（以磅为单位）。

Body - 当前元素。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setMarginRight(marginRight)`

设置右边距（以磅为单位）。

参数

名称	类型	说明
`marginRight`	`Number`	右边距。

Body - 当前元素。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setMarginTop(marginTop)`

设置上边距。

参数

名称	类型	说明
`marginTop`	`Number`	上边距（以点为单位）。

Body - 当前元素。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setPageHeight(pageHeight)`

设置页面高度（以磅为单位）。

参数

名称	类型	说明
`pageHeight`	`Number`	页面高度（以点为单位）。

Body - 当前元素。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setPageWidth(pageWidth)`

设置页面宽度（以磅为单位）。

参数

名称	类型	说明
`pageWidth`	`Number`	页面宽度，以点为单位。

Body - 当前元素。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setText(text)`

将内容设置为纯文本。

注意：系统会清除现有内容。

参数

名称	类型	说明
`text`	`String`	新文本内容。

Body - 当前元素。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setTextAlignment(textAlignment)`

设置文本对齐方式。可用的对齐类型包括 DocumentApp.TextAlignment.NORMAL、DocumentApp.TextAlignment.SUBSCRIPT 和 DocumentApp.TextAlignment.SUPERSCRIPT。

// Make the entire first paragraph in the active tab be superscript.
const documentTab =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
const text = documentTab.getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

参数

名称	类型	说明
`textAlignment`	`TextAlignment`	要应用的文字对齐类型

Body - 当前元素

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

已弃用的方法

`getFootnotes()`

已弃用。此元素不能包含 Footnote。

检索相应部分中包含的所有 Footnotes。

Footnote[]|null - 部分脚注。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getLinkUrl()`

已弃用。不要将链接应用于整个部分，而是将链接应用于该部分中的某个元素。

检索链接网址。

String|null - 链接网址，如果元素包含此属性的多个值，则为 null

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getNextSibling()`

已弃用。此元素没有任何同级元素。

检索元素的下一个同级元素。

下一个同级元素具有相同的父元素，并且位于当前元素之后。

Element|null - 下一个同级元素。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getPreviousSibling()`

已弃用。此元素没有任何同级元素。

检索元素的前一个同级元素。

上一个同级元素具有相同的父元素，并且位于当前元素之前。

Element|null - 上一个同级元素。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`isAtDocumentEnd()`

已弃用。此方法对于 HeaderSection 不可靠。

确定元素是否位于 Document 的末尾。

Boolean - 元素是否位于标签页的末尾。

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setLinkUrl(url)`

已弃用。不要将链接应用于整个部分，而是将链接应用于该部分中的某个元素。

设置链接网址。

参数

名称	类型	说明
`url`	`String`	链接网址

Body - 当前元素

授权

使用此方法的脚本需要获得以下一项或多项范围的授权：

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

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

方法

已弃用的方法

详细文档

appendHorizontalRule()

返回

授权

appendImage(image)

参数

返回

授权

appendImage(image)

参数

返回

授权

appendListItem(listItem)

参数

返回

授权

appendListItem(text)

参数

返回

授权

appendPageBreak()

返回

授权

appendPageBreak(pageBreak)

参数

返回

授权

appendParagraph(paragraph)

参数

返回

授权

appendParagraph(text)

参数

返回

授权

appendTable()

返回

授权

appendTable(cells)

参数

返回

授权

appendTable(table)

参数

返回

授权

clear()

返回

copy()

返回

授权

editAsText()

返回

findElement(elementType)

参数

返回

授权

findElement(elementType, from)

参数

返回

授权

findText(searchPattern)

参数

返回

授权

findText(searchPattern, from)

参数

返回

授权

getAttributes()

返回

授权

getChild(childIndex)

参数

返回

授权

getChildIndex(child)

Class Body

`appendHorizontalRule()`

`appendImage(image)`

`appendImage(image)`

`appendListItem(listItem)`

`appendListItem(text)`

`appendPageBreak()`

`appendPageBreak(pageBreak)`

`appendParagraph(paragraph)`

`appendParagraph(text)`

`appendTable()`

`appendTable(cells)`

`appendTable(table)`

`clear()`

`copy()`

`editAsText()`

`findElement(elementType)`

`findElement(elementType, from)`

`findText(searchPattern)`

`findText(searchPattern, from)`

`getAttributes()`

`getChild(childIndex)`

`getChildIndex(child)`

`getHeadingAttributes(paragraphHeading)`

`getImages()`

`getListItems()`

`getMarginBottom()`

`getMarginLeft()`

`getMarginRight()`

`getMarginTop()`

`getNumChildren()`

`getPageHeight()`

`getPageWidth()`

`getParagraphs()`

`getParent()`

`getTables()`

`getText()`

`getTextAlignment()`

`getType()`

`insertHorizontalRule(childIndex)`

`insertImage(childIndex, image)`

`insertImage(childIndex, image)`

`insertListItem(childIndex, listItem)`

`insertListItem(childIndex, text)`