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

Class ListItem

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

ListItems 不得包含換行字元。換行字元 ("\n") 會轉換為換行字元 ("\r")。

ListItems 的清單 ID 相同，因此屬於同一個清單，並且會依序編號。特定清單的 ListItems 不必在分頁中相鄰，甚至不必有相同的父項元素。屬於同一清單的兩個項目可以在分頁中的任何位置，並且維持連續編號，如以下範例所示：

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

// Append a new list item to the body.
const 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.
const 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 以富文字格式操作元素內容。editAsText 模式會忽略非文字元素 (例如 InlineImage 和 HorizontalRule)。

完全包含在刪除文字範圍內的子元素會從元素中移除。

const 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 開始，搜尋指定類型子項的元素內容。

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

// Define the search parameters.

let searchResult = null;

// Search until the paragraph is found.
while (
    (searchResult = body.findElement(
         DocumentApp.ElementType.PARAGRAPH,
         searchResult,
         ))) {
  const par = searchResult.getElement().asParagraph();
  if (par.getHeading() === DocumentApp.ParagraphHeading.HEADING1) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    break;
  }
}

參數

名稱	類型	說明
`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 列舉中的項目。

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

`getChild(childIndex)`

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

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

// Obtain the first element in the tab.
const 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()`

擷取兒童人數。

const 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() 判斷特定元素的確切類型。

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

`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`	要插入的分頁符號

回攻員

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 的元素。目前元素中包含的任何子項元素都會移至前一個同層元素。

系統會從文件中移除目前的元素。

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

回攻員

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

從父項移除元素。

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

回攻員

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 規則運算式程式庫，因此限制支援的語法。

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

const 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 列舉中的項目，每個屬性值則是要套用的新值。

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

回攻員

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。

清單 ID 會設為指定 ListItem 的相同值。系統會將這兩個 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.
const documentTab =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
const 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