Interface Element

元素

一般元素。Document 內容以元素表示。舉例來說，ListItem、Paragraph 和 Table 都是元素，並沿用 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()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 傳回。

如果特定元素屬於特定類型的類型，請使用這個方法，協助自動完成功能。

Return 鍵

Body — 目前的元素。

授權

如果指令碼使用這個方法，就必須符合下列一或多個範圍的授權：

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

asDate()

將目前元素做為 Date 傳回。

如果知道元素是 Date，請使用此方法將其設為 Date。如此一來，Apps Script 編輯器中的自動完成功能就會顯示可透過 Date 使用的方法。

Return 鍵

Date — 目前類型設為 Date 的元素。

授權

如果指令碼使用這個方法，就必須符合下列一或多個範圍的授權：

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

asEquation()

將目前元素做為 Equation 傳回。

如果特定元素屬於特定類型的類型，請使用這個方法，協助自動完成功能。

Return 鍵

Equation — 目前的元素。

授權

如果指令碼使用這個方法，就必須符合下列一或多個範圍的授權：

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

asEquationFunction()

將目前元素做為 EquationFunction 傳回。

如果特定元素屬於特定類型的類型，請使用這個方法，協助自動完成功能。

Return 鍵

EquationFunction — 目前的元素。

授權

如果指令碼使用這個方法，就必須符合下列一或多個範圍的授權：

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

asEquationFunctionArgumentSeparator()

將目前元素做為 EquationFunctionArgumentSeparator 傳回。

如果特定元素屬於特定類型的類型，請使用這個方法，協助自動完成功能。

Return 鍵

EquationFunctionArgumentSeparator — 目前的元素。

授權

如果指令碼使用這個方法，就必須符合下列一或多個範圍的授權：

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

asEquationSymbol()

將目前元素做為 EquationSymbol 傳回。

如果特定元素屬於特定類型的類型，請使用這個方法，協助自動完成功能。

Return 鍵

EquationSymbol — 目前的元素。

授權

如果指令碼使用這個方法，就必須符合下列一或多個範圍的授權：

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

asFooterSection()

將目前元素做為 FooterSection 傳回。

如果特定元素屬於特定類型的類型，請使用這個方法，協助自動完成功能。

Return 鍵

FooterSection — 目前的元素。

授權

如果指令碼使用這個方法，就必須符合下列一或多個範圍的授權：

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

asFootnote()

將目前元素做為 Footnote 傳回。

如果特定元素屬於特定類型的類型，請使用這個方法，協助自動完成功能。

Return 鍵

Footnote — 目前的元素。

授權

如果指令碼使用這個方法，就必須符合下列一或多個範圍的授權：

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

asFootnoteSection()

將目前元素做為 FootnoteSection 傳回。

如果特定元素屬於特定類型的類型，請使用這個方法，協助自動完成功能。

Return 鍵

FootnoteSection — 目前的元素。

授權

如果指令碼使用這個方法，就必須符合下列一或多個範圍的授權：

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

asHeaderSection()

將目前元素做為 HeaderSection 傳回。

如果特定元素屬於特定類型的類型，請使用這個方法，協助自動完成功能。

Return 鍵

HeaderSection — 目前的元素。

授權

如果指令碼使用這個方法，就必須符合下列一或多個範圍的授權：

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

asHorizontalRule()

將目前元素做為 HorizontalRule 傳回。

如果特定元素屬於特定類型的類型，請使用這個方法，協助自動完成功能。

Return 鍵

HorizontalRule — 目前的元素。

授權

如果指令碼使用這個方法，就必須符合下列一或多個範圍的授權：

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

asInlineDrawing()

將目前元素做為 InlineDrawing 傳回。

如果特定元素屬於特定類型的類型，請使用這個方法，協助自動完成功能。

Return 鍵

InlineDrawing — 目前的元素。

授權

如果指令碼使用這個方法，就必須符合下列一或多個範圍的授權：

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

asInlineImage()

將目前元素做為 InlineImage 傳回。

如果特定元素屬於特定類型的類型，請使用這個方法，協助自動完成功能。

Return 鍵

InlineImage — 目前的元素。

授權

如果指令碼使用這個方法，就必須符合下列一或多個範圍的授權：

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

asListItem()

將目前元素做為 ListItem 傳回。

如果特定元素屬於特定類型的類型，請使用這個方法，協助自動完成功能。

Return 鍵

ListItem — 目前的元素。

授權

如果指令碼使用這個方法，就必須符合下列一或多個範圍的授權：

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

asPageBreak()

將目前元素做為 PageBreak 傳回。

如果特定元素屬於特定類型的類型，請使用這個方法，協助自動完成功能。

Return 鍵

PageBreak — 目前的元素。

授權

如果指令碼使用這個方法，就必須符合下列一或多個範圍的授權：

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

asParagraph()

將目前元素做為 Paragraph 傳回。

如果特定元素屬於特定類型的類型，請使用這個方法，協助自動完成功能。

Return 鍵

Paragraph — 目前的元素。

授權

如果指令碼使用這個方法，就必須符合下列一或多個範圍的授權：

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

asPerson()

將目前元素做為 Person 傳回。

如果知道元素是 Person，請使用此方法設定人員類型。如此一來，Apps Script 編輯器中的自動完成功能就會顯示可用於人員元素的方法。

Return 鍵

Person — 目前類型設為 Person 的元素。

授權

如果指令碼使用這個方法，就必須符合下列一或多個範圍的授權：

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

傳回目前元素的 RichLink，例如 Google 試算表檔案連結。

如果知道元素是 RichLink，請使用此方法將其設為 RichLink。如此一來，Apps Script 編輯器中的自動完成功能就會顯示可搭配 RichLink 使用的方法。

Return 鍵

RichLink — 目前類型設為 RichLink 的元素。

授權

如果指令碼使用這個方法，就必須符合下列一或多個範圍的授權：

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

asTable()

將目前元素做為 Table 傳回。

如果特定元素屬於特定類型的類型，請使用這個方法，協助自動完成功能。

Return 鍵

Table — 目前的元素。

授權

如果指令碼使用這個方法，就必須符合下列一或多個範圍的授權：

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

asTableCell()

將目前元素做為 TableCell 傳回。

如果特定元素屬於特定類型的類型，請使用這個方法，協助自動完成功能。

Return 鍵

TableCell — 目前的元素。

授權

如果指令碼使用這個方法，就必須符合下列一或多個範圍的授權：

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

asTableOfContents()

將目前元素做為 TableOfContents 傳回。

如果特定元素屬於特定類型的類型，請使用這個方法，協助自動完成功能。

Return 鍵

TableOfContents — 目前的元素。

授權

如果指令碼使用這個方法，就必須符合下列一或多個範圍的授權：

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

asTableRow()

將目前元素做為 TableRow 傳回。

如果特定元素屬於特定類型的類型，請使用這個方法，協助自動完成功能。

Return 鍵

TableRow — 目前的元素。

授權

如果指令碼使用這個方法，就必須符合下列一或多個範圍的授權：

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

asText()

將目前元素做為 Text 傳回。

如果特定元素屬於特定類型的類型，請使用這個方法，協助自動完成功能。

Return 鍵

Text — 目前的元素。

授權

如果指令碼使用這個方法，就必須符合下列一或多個範圍的授權：

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

copy()

傳回目前元素的卸離深層連結。

系統也會複製元素中的所有子元素。新元素沒有父項。

Return 鍵

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

Return 鍵

Object — 元素的屬性。

授權

如果指令碼使用這個方法，就必須符合下列一或多個範圍的授權：

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

getNextSibling()

擷取元素和下一個下一個同層級元素。

下一個同層級的父項相同，並沿用目前的元素。

Return 鍵

Element：下一個同層級元素。

授權

如果指令碼使用這個方法，就必須符合下列一或多個範圍的授權：

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

getParent()

擷取元素的父項元素。

父項元素包含目前元素。

Return 鍵

ContainerElement：父項元素。

授權

如果指令碼使用這個方法，就必須符合下列一或多個範圍的授權：

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

getPreviousSibling()

擷取該元素之前的同層級元素。

上一個同層級的父項相同，並加上目前元素。

Return 鍵

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

Return 鍵

ElementType：元素類型，

授權

如果指令碼使用這個方法，就必須符合下列一或多個範圍的授權：

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

isAtDocumentEnd()

判斷元素是否位於 Document 的結尾。

Return 鍵

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

Return 鍵

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

Return 鍵

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

Return 鍵

Element — 目前的元素。

授權

如果指令碼使用這個方法，就必須符合下列一或多個範圍的授權：

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