Class Body

正文

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

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

var 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搜索指定类型的后代元素的内容。
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)

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

此方法还会在表格后附加一个空段落，因为 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）。

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

var 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。 

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

// Define the search parameters.
var searchType = DocumentApp.ElementType.PARAGRAPH;
var searchHeading = DocumentApp.ParagraphHeading.HEADING1;
var searchResult = null;

// Search until the paragraph is found.
while (searchResult = body.findElement(searchType, searchResult)) {
  var par = searchResult.getElement().asParagraph();
  if (par.getHeading() == searchHeading) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    return;
  }
}

参数

名称类型说明
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 枚举中的一个项。 

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

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

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

// Log the paragraph attributes.
for (var att in atts) {
  Logger.log(att + ":" + atts[att]);
}

返回

Object - 元素的属性。

授权

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

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

getChild(childIndex)

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

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

// Obtain the first element in the tab.
var 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()

检索子元素的数量。 

var 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() 确定指定元素的确切类型。 

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

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

var 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 常规 表达式库，限制了支持的语法。

所提供的正则表达式格式会与每个文本块独立进行匹配 当前元素中包含的某些内容。 

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

设置元素的属性。

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

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

// Define a custom paragraph style.
var 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.
var 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.
var documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
var 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

已弃用的方法