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

Class ListItem

代表清單項目的元素。ListItem 是相關聯的 Paragraph 以及清單 IDListItem 可能包含 Equation、Footnote、HorizontalRule、InlineDrawing、InlineImage、PageBreak 和 Text 元素。如要進一步瞭解文件結構，請參閱擴充 Google 文件的指南。

ListItems 不可包含換行字元。換行字元 (「\n」) 為轉換為換行字元 (「\r」)。

清單 ID 相同的 ListItems 屬於同一份清單，系統會據此加上編號。指定清單的 ListItems 不一定要在分頁標籤旁，甚至可以相同的父項元素同一個清單內的兩個項目可能出現在分頁的任意位置連續編號，如以下範例所示：

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

// Append a new list item to the body.
var item1 = body.appendListItem('Item 1');

// Log the new list item's list ID.
Logger.log(item1.getListId());

// Append a table after the list item.
body.appendTable([
  ['Cell 1', 'Cell 2']
]);

// Append a second list item with the same list ID. The two items are treated as the same list,
// despite not being consecutive.
var item2 = body.appendListItem('Item 2');
item2.setListId(item1);

方法

方法	傳回類型	簡短說明
`addPositionedImage(image)`	`PositionedImage`	從指定的圖片 blob 建立及插入新的 `PositionedImage`。
`appendHorizontalRule()`	`HorizontalRule`	建立並附加新的 `HorizontalRule`。
`appendInlineImage(image)`	`InlineImage`	從指定的圖片 blob 建立及附加新的 `InlineImage`。
`appendInlineImage(image)`	`InlineImage`	附加指定的 `InlineImage`。
`appendPageBreak()`	`PageBreak`	建立並附加新的 `PageBreak`。
`appendPageBreak(pageBreak)`	`PageBreak`	附加指定的 `PageBreak`。
`appendText(text)`	`Text`	建立並附加含有指定內容的新 `Text` 元素。
`appendText(text)`	`Text`	附加指定的 `Text` 元素。
`clear()`	`ListItem`	清除元素內容。
`copy()`	`ListItem`	傳回目前元素的卸離的深度副本。
`editAsText()`	`Text`	取得目前元素的 `Text` 版本以進行編輯。
`findElement(elementType)`	`RangeElement`	搜尋指定類型的子系元素內容。
`findElement(elementType, from)`	`RangeElement`	從指定的是 `RangeElement`。
`findText(searchPattern)`	`RangeElement`	使用規則運算式搜尋元素內容，找出指定文字模式。
`findText(searchPattern, from)`	`RangeElement`	從指定的文字模式開始搜尋元素內容搜尋結果。
`getAlignment()`	`HorizontalAlignment`	擷取 `HorizontalAlignment`。
`getAttributes()`	`Object`	擷取元素的屬性。
`getChild(childIndex)`	`Element`	在指定的子索引擷取子元素。
`getChildIndex(child)`	`Integer`	擷取指定子元素的子索引。
`getGlyphType()`	`GlyphType`	擷取清單項目的 `GlyphType`。
`getHeading()`	`ParagraphHeading`	擷取 `ParagraphHeading`。
`getIndentEnd()`	`Number`	擷取結束縮排點的點。
`getIndentFirstLine()`	`Number`	擷取首行縮排 (以點表示)。
`getIndentStart()`	`Number`	擷取起始縮排。
`getLineSpacing()`	`Number`	以點擷取行距。
`getLinkUrl()`	`String`	擷取連結網址。
`getListId()`	`String`	擷取清單 ID。
`getNestingLevel()`	`Integer`	擷取清單項目的巢狀層級。
`getNextSibling()`	`Element`	擷取元素的下一個同層元素。
`getNumChildren()`	`Integer`	擷取子發布商數量。
`getParent()`	`ContainerElement`	擷取元素的父項元素。
`getPositionedImage(id)`	`PositionedImage`	依據映像檔 ID 取得 `PositionedImage`。
`getPositionedImages()`	`PositionedImage[]`	取得固定至段落的所有 `PositionedImage` 物件。
`getPreviousSibling()`	`Element`	擷取元素先前的同層元素。
`getSpacingAfter()`	`Number`	擷取元素之後的間距 (以點為單位)。
`getSpacingBefore()`	`Number`	擷取元素之前的間距 (以點表示)。
`getText()`	`String`	以文字字串形式擷取元素內容。
`getTextAlignment()`	`TextAlignment`	取得文字對齊方式。
`getType()`	`ElementType`	擷取元素的 `ElementType`。
`insertHorizontalRule(childIndex)`	`HorizontalRule`	在指定索引建立並插入 `HorizontalRule`。
`insertInlineImage(childIndex, image)`	`InlineImage`	從指定的映像檔 blob 建立及插入新的 `InlineImage`，位於指定的索引。
`insertInlineImage(childIndex, image)`	`InlineImage`	在指定的索引插入指定的 `InlineImage`。
`insertPageBreak(childIndex)`	`PageBreak`	在指定索引建立並插入新的 `PageBreak`。
`insertPageBreak(childIndex, pageBreak)`	`PageBreak`	在指定的索引插入指定的 `PageBreak`。
`insertText(childIndex, text)`	`Text`	在指定索引建立並插入新的文字元素。
`insertText(childIndex, text)`	`Text`	在指定的索引插入指定的 `Text` 元素，含有指定文字內容。
`isAtDocumentEnd()`	`Boolean`	決定元素是否位於 `Document` 的結尾。
`isLeftToRight()`	`Boolean`	擷取由左至右設定。
`merge()`	`ListItem`	將元素與前述同類型的同層合併。
`removeChild(child)`	`ListItem`	移除指定的子元素。
`removeFromParent()`	`ListItem`	從父項移除元素。
`removePositionedImage(id)`	`Boolean`	依圖片 ID 移除 `PositionedImage`。
`replaceText(searchPattern, replacement)`	`Element`	使用一般的運算式。
`setAlignment(alignment)`	`ListItem`	可設定 `HorizontalAlignment`。
`setAttributes(attributes)`	`ListItem`	設定元素的屬性。
`setGlyphType(glyphType)`	`ListItem`	設定清單項目的 `GlyphType`。
`setHeading(heading)`	`ListItem`	可設定 `ParagraphHeading`。
`setIndentEnd(indentEnd)`	`ListItem`	設定結束縮排 (以點為單位)。
`setIndentFirstLine(indentFirstLine)`	`ListItem`	設定首行縮排 (以點表示)。
`setIndentStart(indentStart)`	`ListItem`	設定起始縮排 (以點表示)。
`setLeftToRight(leftToRight)`	`ListItem`	設定從左到右的設定。
`setLineSpacing(multiplier)`	`ListItem`	設定行距，以數量表示間距可使用的行數。
`setLinkUrl(url)`	`ListItem`	設定連結網址。
`setListId(listItem)`	`ListItem`	設定清單 ID。
`setNestingLevel(nestingLevel)`	`ListItem`	設定清單項目的巢狀層級。
`setSpacingAfter(spacingAfter)`	`ListItem`	設定元素後方的間距。
`setSpacingBefore(spacingBefore)`	`ListItem`	設定元素之前的間距 (以點為單位)。
`setText(text)`	`void`	將清單項目的內容設為文字。
`setTextAlignment(textAlignment)`	`ListItem`	設定文字對齊方式。

內容詳盡的說明文件

`addPositionedImage(image)`

從指定的圖片 blob 建立及插入新的 PositionedImage。

參數

名稱	類型	說明
`image`	`BlobSource`	圖片資料

回攻員

PositionedImage：新定位圖片

授權

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

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

`appendHorizontalRule()`

建立並附加新的 HorizontalRule。

回攻員

HorizontalRule - 新的水平規則

授權

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

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

`appendInlineImage(image)`

從指定的圖片 blob 建立及附加新的 InlineImage。

參數

名稱	類型	說明
`image`	`BlobSource`	圖片資料

回攻員

InlineImage：附加的圖片

授權

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

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

`appendInlineImage(image)`

附加指定的 InlineImage。

參數

名稱	類型	說明
`image`	`InlineImage`	圖片資料

回攻員

InlineImage：附加的圖片

授權

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

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

`appendPageBreak()`

建立並附加新的 PageBreak。

注意：PageBreaks 不得包含在 TableCells 中。如果表格儲存格中包含目前元素，系統就會擲回例外狀況。

回攻員

PageBreak：新的分頁符號元素

授權

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

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

`appendPageBreak(pageBreak)`

附加指定的 PageBreak。

注意：PageBreaks 不得包含在 TableCells 中。如果表格儲存格中包含目前元素，系統就會擲回例外狀況。

參數

名稱	類型	說明
`pageBreak`	`PageBreak`	要附加的分頁符號

回攻員

PageBreak：附加的分頁符號元素

授權

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

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

`appendText(text)`

建立並附加含有指定內容的新 Text 元素。

參數

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

回攻員

Text：新的文字元素

授權

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

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

`appendText(text)`

附加指定的 Text 元素。

參數

名稱	類型	說明
`text`	`Text`	要附加的文字元素

回攻員

Text：附加的文字元素

授權

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

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

`clear()`

清除元素內容。

回攻員

ListItem：目前的元素。

`copy()`

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

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

回攻員

ListItem：新的副本。

授權

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

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

`getAlignment()`

擷取 HorizontalAlignment。

回攻員

HorizontalAlignment：對齊

授權

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

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

`getGlyphType()`

擷取清單項目的 GlyphType。

回攻員

GlyphType：字符類型

授權

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

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

`getHeading()`

擷取 ParagraphHeading。

回攻員

ParagraphHeading：標題

授權

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

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

`getIndentEnd()`

擷取結束縮排點的點。

回攻員

Number：結束縮排，以點數表示

授權

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

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

`getIndentFirstLine()`

擷取首行縮排 (以點表示)。

回攻員

Number：首行縮排，以點表示

授權

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

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

`getIndentStart()`

擷取起始縮排。

回攻員

Number：起始縮排

授權

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

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

`getLineSpacing()`

以點擷取行距。

回攻員

Number：以點表示的行距

授權

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

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

`getListId()`

擷取清單 ID。

回攻員

String：清單 ID

授權

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

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

`getNestingLevel()`

擷取清單項目的巢狀層級。

清單項目的巢狀層級預設為零。字符取決於巢狀層級其他素材資源則會用於清單項目

回攻員

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

`getParent()`

擷取元素的父項元素。

父項元素包含目前元素。

回攻員

ContainerElement：父項元素。

授權

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

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

`getPositionedImage(id)`

依據映像檔 ID 取得 PositionedImage。

參數

名稱	類型	說明
`id`	`String`	圖片 ID

回攻員

PositionedImage：定位圖片

授權

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

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

`getPositionedImages()`

取得固定至段落的所有 PositionedImage 物件。

回攻員

PositionedImage[]：定位圖片清單

授權

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

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

`getSpacingAfter()`

擷取元素之後的間距 (以點為單位)。

回攻員

Number：元素後方的間距，以點表示

授權

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

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

`getSpacingBefore()`

擷取元素之前的間距 (以點表示)。

回攻員

Number：元素前方的間距，以點表示

授權

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

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

`insertHorizontalRule(childIndex)`

在指定索引建立並插入 HorizontalRule。

參數

名稱	類型	說明
`childIndex`	`Integer`	要插入元素的索引

回攻員

HorizontalRule：新的水平規則元素

授權

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

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

`insertInlineImage(childIndex, image)`

從指定的映像檔 blob 建立及插入新的 InlineImage，位於指定的索引。

參數

名稱	類型	說明
`childIndex`	`Integer`	要插入元素的索引
`image`	`BlobSource`	圖片資料

回攻員

InlineImage：插入的內嵌圖片元素

授權

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

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

`insertInlineImage(childIndex, image)`

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

參數

名稱	類型	說明
`childIndex`	`Integer`	要插入元素的索引
`image`	`InlineImage`	圖片資料

回攻員

InlineImage：插入的內嵌圖片元素

授權

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

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

`insertPageBreak(childIndex)`

在指定索引建立並插入新的 PageBreak。

注意：PageBreaks 不得包含在 TableCells 中。如果表格儲存格中包含目前元素，系統就會擲回例外狀況。

參數

名稱	類型	說明
`childIndex`	`Integer`	要插入元素的索引

回攻員

PageBreak：新的分頁符號元素

授權

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

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

`insertPageBreak(childIndex, pageBreak)`

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

注意：PageBreaks 不得包含在 TableCells 中。如果表格儲存格中包含目前元素，系統就會擲回例外狀況。

參數

名稱	類型	說明
`childIndex`	`Integer`	要插入元素的索引
`pageBreak`	`PageBreak`	這個 p[age 暫停時間]

回攻員

PageBreak - 插入的分頁符號元素

授權

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

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

`insertText(childIndex, text)`

在指定索引建立並插入新的文字元素。

參數

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

回攻員

Text：新的文字元素

授權

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

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

`insertText(childIndex, text)`

在指定的索引插入指定的 Text 元素，含有指定文字內容。

參數

名稱	類型	說明
`childIndex`	`Integer`	要插入元素的索引
`text`	`Text`	要插入的文字元素

回攻員

Text：插入的文字元素

授權

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

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

`isLeftToRight()`

擷取由左至右設定。

回攻員

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

回攻員

ListItem：合併的元素。

授權

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

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

`removeChild(child)`

移除指定的子元素。

參數

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

回攻員

ListItem：目前的元素

授權

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

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

回攻員

ListItem：已移除的元素。

授權

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

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

`removePositionedImage(id)`

依圖片 ID 移除 PositionedImage。

參數

名稱	類型	說明
`id`	`String`

回攻員

Boolean：指定圖片是否已移除

授權

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

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

`setAlignment(alignment)`

可設定 HorizontalAlignment。

參數

名稱	類型	說明
`alignment`	`HorizontalAlignment`	水平對齊

回攻員

ListItem：目前的元素

授權

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

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

回攻員

ListItem：目前的元素。

授權

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

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

`setGlyphType(glyphType)`

設定清單項目的 GlyphType。

參數

名稱	類型	說明
`glyphType`	`GlyphType`	字符類型

回攻員

ListItem：目前的元素

授權

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

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

`setHeading(heading)`

可設定 ParagraphHeading。

參數

名稱	類型	說明
`heading`	`ParagraphHeading`	標題

回攻員

ListItem：目前的元素

授權

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

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

`setIndentEnd(indentEnd)`

設定結束縮排 (以點為單位)。

參數

名稱	類型	說明
`indentEnd`	`Number`	結束縮排

回攻員

ListItem：目前的元素

授權

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

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

`setIndentFirstLine(indentFirstLine)`

設定首行縮排 (以點表示)。

參數

名稱	類型	說明
`indentFirstLine`	`Number`	首行縮排

回攻員

ListItem：目前的元素

授權

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

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

`setIndentStart(indentStart)`

設定起始縮排 (以點表示)。

參數

名稱	類型	說明
`indentStart`	`Number`	起始縮排

回攻員

ListItem：目前的元素

授權

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

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

`setLeftToRight(leftToRight)`

設定從左到右的設定。

參數

名稱	類型	說明
`leftToRight`	`Boolean`	由左至右設定

回攻員

ListItem：目前的元素

授權

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

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

`setLineSpacing(multiplier)`

設定行距，以數量表示間距可使用的行數。

參數

名稱	類型	說明
`multiplier`	`Number`	行數

回攻員

ListItem：目前的元素

授權

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

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

`setLinkUrl(url)`

設定連結網址。

參數

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

回攻員

ListItem：目前的元素

授權

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

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

`setListId(listItem)`

設定清單 ID。

指定 ListItem 的清單 ID 設為相同的值。系統會將兩個 ListItems 視為同一清單的成員。

參數

名稱	類型	說明
`listItem`	`ListItem`	要使用其清單 ID 的清單項目

回攻員

ListItem：目前的元素

授權

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

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

`setNestingLevel(nestingLevel)`

設定清單項目的巢狀層級。

清單項目的巢狀層級預設為零。字符取決於巢狀層級其他素材資源則會用於清單項目

參數

名稱	類型	說明
`nestingLevel`	`Integer`	巢狀結構層級

回攻員

ListItem：目前的元素

授權

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

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

`setSpacingAfter(spacingAfter)`

設定元素後方的間距。

參數

名稱	類型	說明
`spacingAfter`	`Number`	元素後方的間距 (以點表示)

回攻員

ListItem：目前的元素

授權

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

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

`setSpacingBefore(spacingBefore)`

設定元素之前的間距 (以點為單位)。

參數

名稱	類型	說明
`spacingBefore`	`Number`	元素前方的間距 (以點表示)

回攻員

ListItem：目前的元素

授權

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

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

`setText(text)`

將清單項目的內容設為文字。

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

參數

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

授權

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

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`	要套用的文字對齊類型

回攻員

ListItem：目前的元素

授權

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

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