本頁面由 Cloud Translation API 翻譯而成。

Class FootnoteSection

代表註腳部分的元素。FootnoteSection 包含對應 Footnote。FootnoteSection 可能包含 ListItem 或 Paragraph 元素。如要進一步瞭解文件結構，請參閱擴充 Google 文件的指南。

方法

方法	傳回類型	簡短說明
`appendParagraph(paragraph)`	`Paragraph`	附加指定的 `Paragraph`。
`appendParagraph(text)`	`Paragraph`	建立並附加含有指定文字內容的新 `Paragraph`。
`clear()`	`FootnoteSection`	清除元素內容。
`copy()`	`FootnoteSection`	傳回目前元素的卸離的深度副本。
`editAsText()`	`Text`	取得目前元素的 `Text` 版本以進行編輯。
`findElement(elementType)`	`RangeElement`	搜尋指定類型的子系元素內容。
`findElement(elementType, from)`	`RangeElement`	從指定的是 `RangeElement`。
`findText(searchPattern)`	`RangeElement`	使用規則運算式搜尋元素內容，找出指定文字模式。
`findText(searchPattern, from)`	`RangeElement`	從指定的文字模式開始搜尋元素內容搜尋結果。
`getAttributes()`	`Object`	擷取元素的屬性。
`getChild(childIndex)`	`Element`	在指定的子索引擷取子元素。
`getChildIndex(child)`	`Integer`	擷取指定子元素的子索引。
`getNextSibling()`	`Element`	擷取元素的下一個同層元素。
`getNumChildren()`	`Integer`	擷取子發布商數量。
`getParagraphs()`	`Paragraph[]`	擷取區段包含的所有 `Paragraphs` (包括 `ListItems`)。
`getParent()`	`ContainerElement`	擷取元素的父項元素。
`getPreviousSibling()`	`Element`	擷取元素先前的同層元素。
`getText()`	`String`	以文字字串形式擷取元素內容。
`getTextAlignment()`	`TextAlignment`	取得文字對齊方式。
`getType()`	`ElementType`	擷取元素的 `ElementType`。
`insertParagraph(childIndex, paragraph)`	`Paragraph`	在指定的索引插入指定的 `Paragraph`。
`insertParagraph(childIndex, text)`	`Paragraph`	在指定索引建立並插入新的 `Paragraph`，其中包含指定的索引例如文字內容，
`removeChild(child)`	`FootnoteSection`	移除指定的子元素。
`removeFromParent()`	`FootnoteSection`	從父項移除元素。
`replaceText(searchPattern, replacement)`	`Element`	使用一般的運算式。
`setAttributes(attributes)`	`FootnoteSection`	設定元素的屬性。
`setText(text)`	`FootnoteSection`	將內容設為純文字。
`setTextAlignment(textAlignment)`	`FootnoteSection`	設定文字對齊方式。

已淘汰的方法

方法	傳回類型	簡短說明
`getFootnotes()`	`Footnote[]`	擷取該區段包含的所有 `Footnotes`。
`getLinkUrl()`	`String`	擷取連結網址。
`isAtDocumentEnd()`	`Boolean`	決定元素是否位於 `Document` 的結尾。
`setLinkUrl(url)`	`FootnoteSection`	設定連結網址。

內容詳盡的說明文件

`appendParagraph(paragraph)`

附加指定的 Paragraph。

附加現有的 Paragraph 副本時，請使用這個版本的 appendParagraph。

參數

名稱	類型	說明
`paragraph`	`Paragraph`	要附加的段落。

回攻員

Paragraph：附加段落。

授權

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

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

`appendParagraph(text)`

建立並附加含有指定文字內容的新 Paragraph。

參數

名稱	類型	說明
`text`	`String`	段落的文字內容。

回攻員

Paragraph - 新段落。

授權

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

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

`clear()`

清除元素內容。

回攻員

FootnoteSection：目前的元素。

`copy()`

傳回目前元素的卸離的深度副本。

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

回攻員

FootnoteSection：新的副本。

授權

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

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

`editAsText()`

取得目前元素的 Text 版本以進行編輯。

您可以使用 editAsText 將元素內容視為 RTF 格式處理。editAsText 模式會忽略非文字元素 (例如 InlineImage 和 HorizontalRule)。

刪除的文字範圍後，系統會移除元素中完全包含的子元素。

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

// Insert two paragraphs separated by a paragraph containing an
// horizontal rule.
body.insertParagraph(0, "An editAsText sample.");
body.insertHorizontalRule(0);
body.insertParagraph(0, "An example.");

// Delete " sample.\n\n An" removing the horizontal rule in the process.
body.editAsText().deleteText(14, 25);

回攻員

Text — 目前元素的文字版本

`findElement(elementType)`

搜尋指定類型的子系元素內容。

參數

名稱	類型	說明
`elementType`	`ElementType`	要搜尋的元素類型。

回攻員

RangeElement：指出搜尋元素位置的搜尋結果。

授權

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

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

`findElement(elementType, from)`

從指定的是 RangeElement。

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

// Define the search parameters.
var searchType = DocumentApp.ElementType.PARAGRAPH;
var searchHeading = DocumentApp.ParagraphHeading.HEADING1;
var searchResult = null;

// Search until the paragraph is found.
while (searchResult = body.findElement(searchType, searchResult)) {
  var par = searchResult.getElement().asParagraph();
  if (par.getHeading() == searchHeading) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    return;
  }
}

參數

名稱	類型	說明
`elementType`	`ElementType`	要搜尋的元素類型。
`from`	`RangeElement`	要搜尋的搜尋結果。

回攻員

RangeElement：指出搜尋元素下一個位置的搜尋結果。

授權

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

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

`findText(searchPattern)`

使用規則運算式搜尋元素內容，找出指定文字模式。

系統不支援部分 JavaScript 規則運算式功能，例如：擷取群組和模式修飾符

系統會將提供的規則運算式模式與每個文字區塊分開比對包含在目前元素中。

參數

名稱	類型	說明
`searchPattern`	`String`	也就是搜尋的模式

回攻員

RangeElement：指出搜尋文字位置的搜尋結果；如果沒有，則傳回空值比對

授權

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

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

`findText(searchPattern, from)`

從指定的文字模式開始搜尋元素內容搜尋結果。

系統不支援部分 JavaScript 規則運算式功能，例如：擷取群組和模式修飾符

系統會將提供的規則運算式模式與每個文字區塊分開比對包含在目前元素中。

參數

名稱	類型	說明
`searchPattern`	`String`	也就是搜尋的模式
`from`	`RangeElement`	要搜尋的搜尋結果

回攻員

RangeElement：指出搜尋文字下一個位置的搜尋結果；如果沒有，則傳回空值比對

授權

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

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

`getChild(childIndex)`

在指定的子索引擷取子元素。

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

// Obtain the first element in the tab.
var firstChild = body.getChild(0);

// If it's a paragraph, set its contents.
if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) {
  firstChild.asParagraph().setText("This is the first paragraph.");
}

參數

名稱	類型	說明
`childIndex`	`Integer`	要擷取的子元素索引。

回攻員

Element：指定索引的子元素。

授權

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

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

`getChildIndex(child)`

擷取指定子元素的子索引。

參數

名稱	類型	說明
`child`	`Element`	要擷取索引的子元素。

回攻員

Integer：子索引。

授權

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

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

`getNumChildren()`

擷取子發布商數量。

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

// Log the number of elements in the tab.
Logger.log("There are " + body.getNumChildren() +
    " elements in the tab's body.");

回攻員

Integer：子項的個數。

授權

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

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

`getParagraphs()`

擷取區段包含的所有 Paragraphs (包括 ListItems)。

回攻員

Paragraph[] - 段落段落。

授權

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

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

`getText()`

以文字字串形式擷取元素內容。

回攻員

String：以文字字串表示的元素內容

授權

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

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

`getTextAlignment()`

取得文字對齊方式。可用的對齊類型包括 DocumentApp.TextAlignment.NORMAL、DocumentApp.TextAlignment.SUBSCRIPT 和 DocumentApp.TextAlignment.SUPERSCRIPT。

回攻員

TextAlignment：文字對齊類型；如果文字包含多種類型文字，則為 null 對齊或從未設定文字對齊方式

授權

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

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

`insertParagraph(childIndex, paragraph)`

在指定的索引插入指定的 Paragraph。

參數

名稱	類型	說明
`childIndex`	`Integer`	要插入的索引。
`paragraph`	`Paragraph`	要插入的段落。

回攻員

Paragraph：插入的段落。

授權

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

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

`insertParagraph(childIndex, text)`

在指定索引建立並插入新的 Paragraph，其中包含指定的索引例如文字內容，

參數

名稱	類型	說明
`childIndex`	`Integer`	要插入的索引。
`text`	`String`	段落的文字內容。

回攻員

Paragraph - 新段落。

授權

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

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

`removeChild(child)`

移除指定的子元素。

參數

名稱	類型	說明
`child`	`Element`	要移除的子元素。

回攻員

FootnoteSection：目前的元素。

授權

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

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

回攻員

FootnoteSection：已移除的元素。

授權

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

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

`replaceText(searchPattern, replacement)`

使用一般的運算式。

搜尋模式會以字串 (而非 JavaScript 規則運算式物件) 的形式傳遞。因此，您必須在模式中逸出所有反斜線。

這個方法使用 Google 的 RE2 一般運算式程式庫，才能限制支援的語法。

系統會將提供的規則運算式模式與每個文字區塊分開比對包含在目前元素中。

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

// Clear the text surrounding "Apps Script", with or without text.
body.replaceText("^.*Apps ?Script.*$", "Apps Script");

參數

名稱	類型	說明
`searchPattern`	`String`	要搜尋的規則運算式模式
`replacement`	`String`	要用於取代的文字

回攻員

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

回攻員

FootnoteSection：目前的元素。

授權

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

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

`setText(text)`

將內容設為純文字。

注意：系統會清除現有內容。

參數

名稱	類型	說明
`text`	`String`	新的文字內容。

回攻員

FootnoteSection：目前的元素。

授權

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

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

`setTextAlignment(textAlignment)`

設定文字對齊方式。可用的對齊類型包括 DocumentApp.TextAlignment.NORMAL、DocumentApp.TextAlignment.SUBSCRIPT 和 DocumentApp.TextAlignment.SUPERSCRIPT。

// Make the entire first paragraph in the active tab be superscript.
var documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
var text = documentTab.getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

參數

名稱	類型	說明
`textAlignment`	`TextAlignment`	要套用的文字對齊類型

回攻員

FootnoteSection：目前的元素

授權

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

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

已淘汰的方法

`getFootnotes()`

已淘汰。這個元素不得包含 Footnote。

擷取該區段包含的所有 Footnotes。

回攻員

Footnote[]：區段註腳。

授權

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

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

`getLinkUrl()`

已淘汰。不要將連結套用到整個區段，而是將連結套用至元素正確的自訂版面

擷取連結網址。

回攻員

String：連結網址；如果元素包含多個值，則為空值

授權

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

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

`isAtDocumentEnd()`

已淘汰。這個方法對於 HeaderSection 來說並不可靠。

決定元素是否位於 Document 的結尾。

回攻員

Boolean：元素是否位於分頁結尾。

授權

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

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

`setLinkUrl(url)`

已淘汰。不要將連結套用到整個區段，而是將連結套用至元素正確的自訂版面

設定連結網址。

參數

名稱	類型	說明
`url`	`String`	連結網址

回攻員

FootnoteSection：目前的元素

授權

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

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