Interface Element

元素

一个通用元素。Document 内容表示为元素。例如,ListItemParagraphTable 是元素,并继承 Element 定义的所有方法,例如 getType()

实现类

名称简介
Body表示文档正文的元素。
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()BodyBody 的形式返回当前元素。
asDate()DateDate 的形式返回当前元素。
asEquation()EquationEquation 的形式返回当前元素。
asEquationFunction()EquationFunctionEquationFunction 的形式返回当前元素。
asEquationFunctionArgumentSeparator()EquationFunctionArgumentSeparatorEquationFunctionArgumentSeparator 的形式返回当前元素。
asEquationSymbol()EquationSymbolEquationSymbol 的形式返回当前元素。
asFooterSection()FooterSectionFooterSection 的形式返回当前元素。
asFootnote()FootnoteFootnote 的形式返回当前元素。
asFootnoteSection()FootnoteSectionFootnoteSection 的形式返回当前元素。
asHeaderSection()HeaderSectionHeaderSection 的形式返回当前元素。
asHorizontalRule()HorizontalRuleHorizontalRule 的形式返回当前元素。
asInlineDrawing()InlineDrawingInlineDrawing 的形式返回当前元素。
asInlineImage()InlineImageInlineImage 的形式返回当前元素。
asListItem()ListItemListItem 的形式返回当前元素。
asPageBreak()PageBreakPageBreak 的形式返回当前元素。
asParagraph()ParagraphParagraph 的形式返回当前元素。
asPerson()PersonPerson 的形式返回当前元素。
asRichLink()RichLinkRichLink 的形式返回当前元素,例如 Google 表格文件的链接。
asTable()TableTable 的形式返回当前元素。
asTableCell()TableCellTableCell 的形式返回当前元素。
asTableOfContents()TableOfContentsTableOfContents 的形式返回当前元素。
asTableRow()TableRowTableRow 的形式返回当前元素。
asText()TextText 的形式返回当前元素。
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 body = DocumentApp.getActiveDocument().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 body = DocumentApp.getActiveDocument().getBody();

// Obtain the first element in the document 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 body = DocumentApp.getActiveDocument().getBody();
// Example 1: Merge paragraphs
// Append two paragraphs to the document.
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 body = DocumentApp.getActiveDocument().getBody();

// Remove all images in the document 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 body = DocumentApp.getActiveDocument().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