此页面由 Cloud Translation API 翻译。

Class ContainerElement

一个可能包含其他元素的通用元素。所有可能包含子元素的元素（例如 Paragraph）都继承自 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`	设置文本对齐方式。

详细文档

`asBody()`

以 Body 的形式返回当前元素。

每当知道给定元素属于特定类型时，请使用此方法来辅助自动补全。

Body - 当前元素。

授权

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

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

`asEquation()`

以 Equation 的形式返回当前元素。

每当知道给定元素属于特定类型时，请使用此方法来辅助自动补全。

Equation - 当前元素。

授权

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

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

`asFooterSection()`

以 FooterSection 的形式返回当前元素。

每当知道给定元素属于特定类型时，请使用此方法来辅助自动补全。

FooterSection - 当前元素。

授权

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

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

`asFootnoteSection()`

以 FootnoteSection 的形式返回当前元素。

每当知道给定元素属于特定类型时，请使用此方法来辅助自动补全。

FootnoteSection - 当前元素。

授权

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

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

`asHeaderSection()`

以 HeaderSection 的形式返回当前元素。

每当知道给定元素属于特定类型时，请使用此方法来辅助自动补全。

HeaderSection - 当前元素。

授权

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

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

`asListItem()`

以 ListItem 的形式返回当前元素。

每当知道给定元素属于特定类型时，请使用此方法来辅助自动补全。

ListItem - 当前元素。

授权

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

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

`asParagraph()`

以 Paragraph 的形式返回当前元素。

每当知道给定元素属于特定类型时，请使用此方法来辅助自动补全。

Paragraph - 当前元素。

授权

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

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

`asTable()`

以 Table 的形式返回当前元素。

每当知道给定元素属于特定类型时，请使用此方法来辅助自动补全。

Table - 当前元素。

授权

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

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

`asTableCell()`

以 TableCell 的形式返回当前元素。

每当知道给定元素属于特定类型时，请使用此方法来辅助自动补全。

TableCell - 当前元素。

授权

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

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

`asTableOfContents()`

以 TableOfContents 的形式返回当前元素。

每当知道给定元素属于特定类型时，请使用此方法来辅助自动补全。

TableOfContents - 当前元素。

授权

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

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

`asTableRow()`

以 TableRow 的形式返回当前元素。

每当知道给定元素属于特定类型时，请使用此方法来辅助自动补全。

TableRow - 当前元素。

授权

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

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

`clear()`

清除元素的内容。

ContainerElement - 当前元素。

`copy()`

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

系统还会复制该元素中的所有子元素。新元素没有父元素。

ContainerElement - 新副本。

授权

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

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 - 搜索结果，用于指示搜索元素的位置。

授权

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

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 - 指示搜索元素的下一个位置的搜索结果。

授权

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

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

`findText(searchPattern)`

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

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

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

参数

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

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

授权

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

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

`findText(searchPattern, from)`

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

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

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

参数

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

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

参数

名称	类型	说明
`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

`getLinkUrl()`

检索链接网址。

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

授权

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

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

`getNextSibling()`

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

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

Element - 下一个同级元素。

授权

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

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

`getParent()`

检索元素的父元素。

父元素包含当前元素。

ContainerElement - 父元素。

授权

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

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

`getPreviousSibling()`

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

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

Element - 上一个同级元素。

授权

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

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

`isAtDocumentEnd()`

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

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

授权

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

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

`merge()`

将元素与同一类型的上一个同级元素合并。

只有同一 ElementType 的元素才能合并。当前元素包含的所有子元素都会移至前面的同级元素。

当前元素会从文档中移除。

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

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
const par1 = body.appendParagraph('Paragraph 1.');
const par2 = body.appendParagraph('Paragraph 2.');
// Merge the newly added paragraphs into a single paragraph.
par2.merge();

// Example 2: Merge table cells
// Create a two-dimensional array containing the table's cell contents.
const cells = [
  ['Row 1, Cell 1', 'Row 1, Cell 2'],
  ['Row 2, Cell 1', 'Row 2, Cell 2'],
];
// Build a table from the array.
const table = body.appendTable(cells);
// Get the first row in the table.
const row = table.getRow(0);
// Get the two cells in this row.
const cell1 = row.getCell(0);
const cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
const merged = cell2.merge();

ContainerElement - 合并后的元素。

授权

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

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

`removeFromParent()`

从其父元素中移除元素。

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

// Remove all images in the active tab's body.
const imgs = body.getImages();
for (let i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

ContainerElement - 移除的元素。

授权

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

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`	元素的属性。

ContainerElement - 当前元素。

授权

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

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

`setLinkUrl(url)`

设置链接网址。

参数

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

ContainerElement - 当前元素

授权

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

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`	要应用的文本对齐方式

ContainerElement - 当前元素

授权

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

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