本頁面由 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`	代表 RTF 格式區域的元素。
`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。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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 列舉中的項目。

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

參數

名稱	類型	說明
`attributes`	`Object`	元素的屬性。

回攻員

Element：目前的元素。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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