此页面由 Cloud Translation API 翻译。

Interface Element

通用元素。Document 内容以元素的形式表示。例如，ListItem、Paragraph 和 Table 是元素，并继承了 Element 定义的所有方法，例如 getType()。

实现类

名称	简介
`Body`	Google 文档中标签页中的内容。
`ContainerElement`	一个可能包含其他元素的通用元素。
`Date`	表示格式化日期的元素
`Equation`	表示数学表达式的元素。
`EquationFunction`	表示数学 `Equation` 中的函数的元素。
`EquationFunctionArgumentSeparator`	表示数学 `Equation` 中的函数分隔符的元素。
`EquationSymbol`	表示数学 `Equation` 中的符号的元素。
`FooterSection`	表示页脚部分的元素。
`Footnote`	表示脚注的元素。
`FootnoteSection`	表示脚注部分的元素。
`HeaderSection`	表示标题部分的元素。
`HorizontalRule`	表示水平线的元素。
`InlineDrawing`	表示嵌入式绘图的元素。
`InlineImage`	表示嵌入图片的元素。
`ListItem`	表示列表项的元素。
`PageBreak`	表示分页的元素。
`Paragraph`	表示段落的元素。
`Person`	表示指向人物的链接的元素。
`RichLink`	表示指向 Google 资源（例如云端硬盘文件或 YouTube 视频）的链接的元素。
`Table`	表示表格的元素。
`TableCell`	表示表格单元格的元素。
`TableOfContents`	包含目录的元素。
`TableRow`	表示表格的行。
`Text`	表示富文本区域的元素。
`UnsupportedElement`	表示未知或无法受脚本影响的区域的元素，例如页码。

方法

方法	返回类型	简介
`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`	设置元素的属性。

详细文档

`asBody()`

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

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

Body - 当前元素。

授权

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

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

`asDate()`

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

如果您知道某个元素是 Date，请使用此方法将其类型设置为 Date。这样一来，Apps Script 编辑器中的自动补全功能就会显示可与 Date 搭配使用的各个方法。

Date - 当前元素，其类型设为 Date。

授权

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

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

`asEquationFunction()`

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

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

EquationFunction - 当前元素。

授权

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

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

`asEquationFunctionArgumentSeparator()`

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

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

EquationFunctionArgumentSeparator - 当前元素。

授权

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

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

`asEquationSymbol()`

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

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

EquationSymbol - 当前元素。

授权

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

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

`asFootnote()`

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

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

Footnote - 当前元素。

授权

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

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

`asHorizontalRule()`

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

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

HorizontalRule - 当前元素。

授权

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

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

`asInlineDrawing()`

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

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

InlineDrawing - 当前元素。

授权

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

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

`asInlineImage()`

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

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

InlineImage - 当前元素。

授权

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

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

`asPageBreak()`

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

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

PageBreak - 当前元素。

授权

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

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

`asPerson()`

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

如果您知道某个元素是 Person，请使用此方法将其类型设为“人”。这样一来，Apps Script 编辑器中的自动补全功能就会显示可用于 person 元素的方法。

Person - 当前元素，其类型设为 Person。

授权

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

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

`asRichLink()`

以 RichLink 的形式返回当前元素，例如 Google 表格文件的链接。

如果您知道某个元素是 RichLink，请使用此方法将其类型设置为 RichLink。这样一来，Apps Script 编辑器中的自动补全功能就会显示可与 RichLink 搭配使用的函数。

RichLink - 当前元素，其类型设为 RichLink。

授权

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

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

`asText()`

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

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

Text - 当前元素。

授权

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

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

`copy()`

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

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

Element - 新副本。

授权

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

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

`getNextSibling()`

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

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

Element - 下一个同级元素。

授权

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

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

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

Element - 合并后的元素。

授权

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

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

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

Element - 当前元素。

授权

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

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