Class Body

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为每个指定的字符串值附加一个包含 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设置文本对齐方式。

详细文档

appendHorizontalRule()

创建并附加新的 HorizontalRule。

HorizontalRule 将包含在新 Paragraph 中。

返回

HorizontalRule - 新的水平线。

授权

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

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

appendImage(image)

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

该图片将包含在新 Paragraph 中。

参数

名称类型说明
imageBlobSource图片数据。

返回

InlineImage - 附加的图片。

授权

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

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

appendImage(image)

附加给定的 InlineImage。

InlineImage 将包含在新 Paragraph 中。

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

参数

名称类型说明
imageInlineImage图片数据。

返回

InlineImage - 附加的图片。

授权

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

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

appendListItem(listItem)

附加给定的 ListItem。

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

参数

名称类型说明
listItemListItem要附加的列表项。

返回

ListItem - 附加的列表项。

授权

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

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

appendListItem(text)

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

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

参数

名称类型说明
textString列表项的文本内容。

返回

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。

参数

名称类型说明
pageBreakPageBreak要附加的分页符。

返回

PageBreak - 附加的分页符。

授权

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

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

appendParagraph(paragraph)

附加给定的 Paragraph。

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

参数

名称类型说明
paragraphParagraph要附加的段落。

返回

Paragraph - 附加的段落。

授权

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

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

appendParagraph(text)

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

参数

名称类型说明
textString段落的文本内容。

返回

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)

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

由于 Google 文档文档不能以表格结尾，因此此方法还会在表格后面附加一个空白段落。

参数

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

返回

Table - 附加的表。

授权

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

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

appendTable(table)

附加给定的 Table。

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

参数

名称类型说明
tableTable要附加的表。

返回

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)

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

参数

名称类型说明
elementTypeElementType要搜索的元素类型。

返回

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

授权

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

  • 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;
  }
}

参数

名称类型说明
elementTypeElementType要搜索的元素类型。
fromRangeElement要搜索的搜索结果。

返回

RangeElement - 指示搜索元素的下一个位置的搜索结果。

授权

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

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

findText(searchPattern)

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

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

系统会将提供的正则表达式模式与当前元素中包含的每个文本块进行单独匹配。

参数

名称类型说明
searchPatternString要搜索的模式

返回

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

授权

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

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

findText(searchPattern, from)

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

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

系统会将提供的正则表达式模式与当前元素中包含的每个文本块进行单独匹配。

参数

名称类型说明
searchPatternString要搜索的模式
fromRangeElement要搜索的搜索结果

返回

RangeElement - 搜索结果，表示搜索文本的下一个位置；如果没有匹配项，则为 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.');
}

参数

名称类型说明
childIndexInteger要检索的子元素的索引。

返回

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

授权

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

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

getChildIndex(child)

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

参数

名称类型说明
childElement要检索索引的子元素。

返回

Integer - 子索引。

授权

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

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

getHeadingAttributes(paragraphHeading)

检索所提供 ParagraphHeading 的一组属性。

参数

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

返回

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

授权

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

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

getImages()

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

返回

InlineImage[] - 版块图片。

授权

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

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

getListItems()

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

返回

ListItem[] - 版块列表项。

授权

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

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

getMarginBottom()

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

返回

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

授权

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

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

getMarginLeft()

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

返回

Number - 左边距（以点为单位）。

授权

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

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

getMarginRight()

检索右外边距。

返回

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

授权

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

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

getMarginTop()

检索上外边距。

返回

Number - 上边距（以点为单位）。

授权

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

  • 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 - 页面高度（以点为单位）。

授权

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

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

getPageWidth()

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

返回

Number - 页面宽度（以磅为单位）。

授权

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

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

getParagraphs()

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

返回

Paragraph[] - 版块段落。

授权

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

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

getParent()

检索元素的父元素。

父元素包含当前元素。

返回

ContainerElement - 父元素。

授权

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

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

getTables()

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

返回

Table[] - 分区表。

授权

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

  • 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

授权

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

  • 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 中。

参数

名称类型说明
childIndexInteger要插入元素的索引。

返回

HorizontalRule - 新的水平线。

授权

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

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

insertImage(childIndex, image)

在指定位置从指定图片 blob 创建并插入 InlineImage。

参数

名称类型说明
childIndexInteger要插入元素的索引。
imageBlobSource图片数据。

返回

InlineImage - 插入的内嵌图片。

授权

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

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

insertImage(childIndex, image)

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

该图片将包含在新 Paragraph 中。

参数

名称类型说明
childIndexInteger要插入元素的索引。
imageInlineImage要插入的图片。

返回

InlineImage - 插入的内嵌图片。

授权

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

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

insertListItem(childIndex, listItem)

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

参数

名称类型说明
childIndexInteger要插入的索引。
listItemListItem要插入的列表项。

返回

ListItem - 插入的列表项。

授权

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

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

insertListItem(childIndex, text)

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

参数

名称类型说明
childIndexInteger要插入的索引。
textString列表项的文本内容。

返回

ListItem - 新列表项。

授权

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

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

insertPageBreak(childIndex)

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

PageBreak 将包含在新 Paragraph 中。

参数

名称类型说明
childIndexInteger要插入元素的索引。

返回

PageBreak - 新分页符。

授权

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

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

insertPageBreak(childIndex, pageBreak)

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

PageBreak 将包含在新 Paragraph 中。

参数

名称类型说明
childIndexInteger要插入元素的索引。
pageBreakPageBreak要插入的分页符。

返回

PageBreak - 插入的分页符。

授权

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

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

insertParagraph(childIndex, paragraph)

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

参数

名称类型说明
childIndexInteger要插入的索引。
paragraphParagraph要插入的段落。

返回

Paragraph - 插入的段落。

授权

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

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

insertParagraph(childIndex, text)

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

参数

名称类型说明
childIndexInteger要插入的索引。
textString段落的文本内容。

返回

Paragraph - 新段落。

授权

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

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

insertTable(childIndex)

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

参数

名称类型说明
childIndexInteger要插入的索引。

返回

Table - 新表。

授权

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

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

insertTable(childIndex, cells)

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

参数

名称类型说明
childIndexInteger要插入的索引。
cellsString[][]要添加到新表中的表格单元格的文本内容。

返回

Table - 新表。

授权

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

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

insertTable(childIndex, table)

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

参数

名称类型说明
childIndexInteger要插入的索引。
tableTable要插入的表。

返回

Table - 插入的表格。

授权

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

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

removeChild(child)

移除指定的子元素。

参数

名称类型说明
childElement要移除的子元素。

返回

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');

参数

名称类型说明
searchPatternString要搜索的正则表达式模式
replacementString要用作替换项的文本

返回

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);

参数

名称类型说明
attributesObject元素的属性。

返回

Body - 当前元素。

授权

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

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

setHeadingAttributes(paragraphHeading, attributes)

为所提供的 ParagraphHeading 设置属性。

参数

名称类型说明
paragraphHeadingParagraphHeading应设置其属性的标题。
attributesObject属性及其要设置的值的映射。

返回

Body - 当前元素。

授权

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

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

setMarginBottom(marginBottom)

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

参数

名称类型说明
marginBottomNumber下边距（以点为单位）。

返回

Body - 当前元素。

授权

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

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

setMarginLeft(marginLeft)

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

参数

名称类型说明
marginLeftNumber左边距（以点为单位）。

返回

Body - 当前元素。

授权

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

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

setMarginRight(marginRight)

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

参数

名称类型说明
marginRightNumber右边距。

返回

Body - 当前元素。

授权

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

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

setMarginTop(marginTop)

设置上边距。

参数

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

返回

Body - 当前元素。

授权

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

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

setPageHeight(pageHeight)

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

参数

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

返回

Body - 当前元素。

授权

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

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

setPageWidth(pageWidth)

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

参数

名称类型说明
pageWidthNumber页面宽度（以点为单位）。

返回

Body - 当前元素。

授权

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

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

setText(text)

将内容设置为纯文本。

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

参数

名称类型说明
textString新的文本内容。

返回

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);

参数

名称类型说明
textAlignmentTextAlignment要应用的文本对齐方式

返回

Body - 当前元素

授权

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

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

已弃用的方法