Interface Element

元素

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

实现类

名称简介
BodyGoogle 文档文档中标签页的内容。
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 脚本编辑器中的自动补全功能便会向您显示可以使用的方法 并使用 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 脚本编辑器中的自动补全功能便会向您显示可用于 人物元素。

返回

Person - 类型设为 Person 的当前元素。

授权

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

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

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

如果您知道某个元素是 RichLink，可以使用此方法将其类型设置为 RichLink。这样，Apps 脚本编辑器中的自动补全功能便会向您显示您可以 与 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 枚举中的一个项。 

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

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

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

isAtDocumentEnd()

确定元素是否在 Document 的末尾。

返回

Boolean - 表示元素是否在标签页的末尾。

授权

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

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

merge()

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

只能合并同一 ElementType 的元素。文件中包含的 当前元素会移动到前一个同级元素。

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

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

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
var par1 = body.appendParagraph('Paragraph 1.');
var 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.
var cells = [
['Row 1, Cell 1', 'Row 1, Cell 2'],
['Row 2, Cell 1', 'Row 2, Cell 2']
];
// Build a table from the array.
var table = body.appendTable(cells);
// Get the first row in the table.
 var row = table.getRow(0);
// Get the two cells in this row.
var cell1 = row.getCell(0);
var cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
var merged = cell2.merge();

返回

Element - 合并的元素。

授权

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

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

removeFromParent()

将元素从其父元素中移除。 

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

// Remove all images in the active tab's body.
var imgs = body.getImages();
for (var 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)

设置元素的属性。

指定的属性参数必须是一个对象，其中每个属性名称都是 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元素的属性。

返回

Element - 当前元素。

授权

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

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