本頁面由 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。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

設定元素的屬性。

指定的屬性參數必須是物件，其中每個屬性名稱都是 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