Class ListItem

透過集合功能整理內容 你可以依據偏好儲存及分類內容。
ListItem

代表清單項目的元素。ListItem 是與清單 ID 相關聯的 ParagraphListItem 可能包含 EquationFootnoteHorizontalRuleInlineDrawingInlineImagePageBreakText 元素。如要進一步瞭解文件結構,請參閱擴充 Google 文件的指南

ListItems 不可包含換行符號字元。新行字元 (「&」) 會轉換成換行字元。

具有相同清單 ID 的 ListItems 隸屬於同一個清單,並據此進行編號。特定清單的 ListItems 不一定要位於文件附近,甚至具有相同的父項元素。屬於相同清單的兩個項目可能會存在於文件中的任何位置,同時保持連續編號,如以下範例所示:

var body = DocumentApp.getActiveDocument().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

參數

名稱類型說明
imageBlobSource圖片資料

Return 鍵

PositionedImage:新的位置圖片

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

appendHorizontalRule()

建立並附加新的 HorizontalRule

Return 鍵

HorizontalRule:新的水平規則

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

appendInlineImage(image)

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

參數

名稱類型說明
imageBlobSource圖片資料

Return 鍵

InlineImage:附加的圖片

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

appendInlineImage(image)

附加指定的 InlineImage

參數

名稱類型說明
imageInlineImage圖片資料

Return 鍵

InlineImage:附加的圖片

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

appendPageBreak()

建立並附加新的 PageBreak

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

Return 鍵

PageBreak — 新的分頁符號元素

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

appendPageBreak(pageBreak)

附加指定的 PageBreak

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

參數

名稱類型說明
pageBreakPageBreak要附加的分頁符號

Return 鍵

PageBreak — 附加的分頁符號元素

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

appendText(text)

使用指定內容建立並附加新的 Text 元素。

參數

名稱類型說明
textString文字內容

Return 鍵

Text:新的文字元素

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

appendText(text)

附加指定的 Text 元素。

參數

名稱類型說明
textText要附加的文字元素

Return 鍵

Text:附加的文字元素

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

clear()

清除元素的內容。

Return 鍵

ListItem:目前的元素


copy()

傳回目前元素的卸離深層連結。

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

Return 鍵

ListItem — 新副本。

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

editAsText()

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

使用 editAsText 將元素內容操控為 RTF 格式。editAsText 模式會忽略非文字元素,例如 InlineImageHorizontalRule

屬於已刪除文字範圍的子項元素會從元素中移除。

var body = DocumentApp.getActiveDocument().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);

Return 鍵

Text:目前元素的文字版本


findElement(elementType)

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

參數

名稱類型說明
elementTypeElementType要搜尋的元素類型

Return 鍵

RangeElement:代表搜尋元素位置的搜尋結果

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

findElement(elementType, from)

從指定內容的 RangeElement 開始搜尋元素內容的子系。

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().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;
  }
}

參數

名稱類型說明
elementTypeElementType要搜尋的元素類型
fromRangeElement要搜尋的結果

Return 鍵

RangeElement:代表搜尋元素下一個位置的搜尋結果

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

findText(searchPattern)

使用規則運算式搜尋元素中的文字內容。

無法完整支援 JavaScript 規則運算式的子集,例如擷取群組和模式修飾符。

提供的規則運算式模式與目前元素所包含的每個文字區塊各自獨立。

參數

名稱類型說明
searchPatternString要搜尋的模式

Return 鍵

RangeElement:代表搜尋文字位置的搜尋結果,如果沒有比對結果,則傳回空值

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

findText(searchPattern, from)

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

無法完整支援 JavaScript 規則運算式的子集,例如擷取群組和模式修飾符。

提供的規則運算式模式與目前元素所包含的每個文字區塊各自獨立。

參數

名稱類型說明
searchPatternString要搜尋的模式
fromRangeElement要搜尋的結果

Return 鍵

RangeElement:代表搜尋文字的下一個位置;如果沒有相符項目,則傳回空值

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

getAlignment()

擷取 HorizontalAlignment

Return 鍵

HorizontalAlignment — 對齊

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

getAttributes()

擷取元素的屬性。

結果是物件的一個物件,其中包含每個有效元素屬性的屬性,每個屬性名稱都會對應到 DocumentApp.Attribute 列舉中的項目。

var body = DocumentApp.getActiveDocument().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]);
}

Return 鍵

Object — 元素的屬性。

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

getChild(childIndex)

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

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Obtain the first element in the document.
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.");
}

參數

名稱類型說明
childIndexInteger要擷取的子元素索引

Return 鍵

Element:指定索引的子元素

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

getChildIndex(child)

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

參數

名稱類型說明
childElement擷取索引的子元素

Return 鍵

Integer:子索引

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

getGlyphType()

擷取清單項目 GlyphType

Return 鍵

GlyphType:字符類型

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

getHeading()

擷取 ParagraphHeading

Return 鍵

ParagraphHeading:標題

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

getIndentEnd()

擷取起始縮排。

Return 鍵

Number:結束縮排 (點)

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

getIndentFirstLine()

擷取起始行縮排。

Return 鍵

Number — 第一行縮排 (點)

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

getIndentStart()

擷取起始縮排。

Return 鍵

Number:起始縮排

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

getLineSpacing()

擷取以行為單位的行距。

Return 鍵

Number — 行距 (以點為單位)

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

getLinkUrl()

擷取連結網址。

Return 鍵

String:連結網址,如果元素包含多個屬性,則傳回空值

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

getListId()

擷取清單 ID。

Return 鍵

String:清單 ID

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

getNestingLevel()

擷取清單項目巢狀結構層級。

根據預設,清單項目的巢狀層級為零。巢狀層級會決定清單項目使用的字符。

Return 鍵

Integer:巢狀層級

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

getNextSibling()

擷取元素和下一個下一個同層級元素。

下一個同層級的父項相同,並沿用目前的元素。

Return 鍵

Element:下一個同層級元素。

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

getNumChildren()

擷取子項數量。

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

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

Return 鍵

Integer:子項數量

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

getParent()

擷取元素的父項元素。

父項元素包含目前元素。

Return 鍵

ContainerElement:父項元素。

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

getPositionedImage(id)

根據圖片 ID 取得 PositionedImage

參數

名稱類型說明
idString圖片 ID

Return 鍵

PositionedImage:調整後的圖片

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

getPositionedImages()

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

Return 鍵

PositionedImage[]:指定的位置清單

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

getPreviousSibling()

擷取該元素之前的同層級元素。

上一個同層級的父項相同,並加上目前元素。

Return 鍵

Element:上一個同層級元素。

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

getSpacingAfter()

擷取元素後方的間距。

Return 鍵

Number — 元素後方的間距 (以點為單位)

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

getSpacingBefore()

擷取元素前面的間距。

Return 鍵

Number - 元素前的間距 (點)

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

getText()

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

Return 鍵

String:元素內容,以文字字串表示

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

getTextAlignment()

取得文字對齊方式。可用的對齊類型為 DocumentApp.TextAlignment.NORMALDocumentApp.TextAlignment.SUBSCRIPTDocumentApp.TextAlignment.SUPERSCRIPT

Return 鍵

TextAlignment:文字對齊方式類型;如果文字含有多種文字對齊方式 (或從未設定文字對齊方式),則為 null

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

getType()

擷取元素的 ElementType

使用 getType() 來判斷特定元素的確切類型。

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

// Obtain the first element in the document 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.');
}

Return 鍵

ElementType:元素類型,

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

insertHorizontalRule(childIndex)

建立並插入指定索引的 HorizontalRule

參數

名稱類型說明
childIndexInteger插入元素的索引

Return 鍵

HorizontalRule:新的水平規則元素

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

insertInlineImage(childIndex, image)

使用指定的圖片 blob 在指定的索引上插入及插入新的 InlineImage

參數

名稱類型說明
childIndexInteger插入元素的索引
imageBlobSource圖片資料

Return 鍵

InlineImage:插入的內嵌圖片元素

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

insertInlineImage(childIndex, image)

在指定的索引插入 InlineImage

參數

名稱類型說明
childIndexInteger插入元素的索引
imageInlineImage圖片資料

Return 鍵

InlineImage:插入的內嵌圖片元素

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

insertPageBreak(childIndex)

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

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

參數

名稱類型說明
childIndexInteger插入元素的索引

Return 鍵

PageBreak — 新的分頁符號元素

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

insertPageBreak(childIndex, pageBreak)

在指定的索引插入 PageBreak

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

參數

名稱類型說明
childIndexInteger插入元素的索引
pageBreakPageBreak插入要插入的 P[age]

Return 鍵

PageBreak — 插入的分頁符號元素

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

insertText(childIndex, text)

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

參數

名稱類型說明
childIndexInteger插入元素的索引
textString文字內容

Return 鍵

Text:新的文字元素

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

insertText(childIndex, text)

以指定的文字內容插入指定的 Text 元素。

參數

名稱類型說明
childIndexInteger插入元素的索引
textText要插入的文字元素

Return 鍵

Text:插入的文字元素

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

isAtDocumentEnd()

判斷元素是否位於 Document 的結尾。

Return 鍵

Boolean — 元素是否位於文件結尾。

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

isLeftToRight()

擷取從左到右的設定。

Return 鍵

Boolean - 從左到右設定

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

merge()

將元素與前相同類型的同層級合併。

只能合併同一個 ElementType 的元素。目前元素中的所有子項元素都會移至先前的同層級元素。

目前的元素將從文件中移除。

var body = DocumentApp.getActiveDocument().getBody();
// Example 1: Merge paragraphs
// Append two paragraphs to the document.
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();

Return 鍵

ListItem — 合併的元素。

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

removeChild(child)

移除指定的子元素。

參數

名稱類型說明
childElement要移除的子元素

Return 鍵

ListItem:目前的元素

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

removeFromParent()

從父項中移除元素。

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

// Remove all images in the document body.
var imgs = body.getImages();
for (var i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

Return 鍵

ListItem — 移除的元素。

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

removePositionedImage(id)

移除映像檔 ID 的 PositionedImage

參數

名稱類型說明
idString

Return 鍵

Boolean — 是否移除指定圖片

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

replaceText(searchPattern, replacement)

使用規則運算式將特定文字模式的所有出現情況替換為特定替代字串。

搜尋模式會以字串的形式傳遞,而不是 JavaScript 規則運算式物件。因此,你必須在模式中逸出任何反斜線。

這個方法使用 Google' 的 RE2 規則運算式程式庫,因此會限制支援的語法

提供的規則運算式模式與目前元素所包含的每個文字區塊各自獨立。

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

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

參數

名稱類型說明
searchPatternString要搜尋的規則運算式模式
replacementString要做為替換的文字

Return 鍵

Element:目前的元素

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

setAlignment(alignment)

可設定 HorizontalAlignment

參數

名稱類型說明
alignmentHorizontalAlignment水平對齊

Return 鍵

ListItem:目前的元素

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

setAttributes(attributes)

設定元素的屬性。

指定的屬性參數必須是物件,其中每個屬性名稱都是 DocumentApp.Attribute 列舉中的一個項目,而每個屬性值都是要套用的新值。

var body = DocumentApp.getActiveDocument().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);

參數

名稱類型說明
attributesObject元素的屬性。

Return 鍵

ListItem — 目前的元素。

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

setGlyphType(glyphType)

設定清單項目的 GlyphType

參數

名稱類型說明
glyphTypeGlyphType字符類型

Return 鍵

ListItem:目前的元素

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

setHeading(heading)

可設定 ParagraphHeading

參數

名稱類型說明
headingParagraphHeading標題

Return 鍵

ListItem:目前的元素

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

setIndentEnd(indentEnd)

設定起始縮排。

參數

名稱類型說明
indentEndNumber結尾縮排

Return 鍵

ListItem:目前的元素

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

setIndentFirstLine(indentFirstLine)

設定第一行縮排 (點)。

參數

名稱類型說明
indentFirstLineNumber第一行縮排 (點)

Return 鍵

ListItem:目前的元素

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

setIndentStart(indentStart)

設定起始縮排。

參數

名稱類型說明
indentStartNumber起始縮排

Return 鍵

ListItem:目前的元素

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

setLeftToRight(leftToRight)

設定從左到右的設定。

參數

名稱類型說明
leftToRightBoolean從左到右設定

Return 鍵

ListItem:目前的元素

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

setLineSpacing(multiplier)

設定行距,以數量表示間距的行數。

參數

名稱類型說明
multiplierNumber行數

Return 鍵

ListItem:目前的元素

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

setLinkUrl(url)

設定連結網址。

參數

名稱類型說明
urlString連結網址

Return 鍵

ListItem:目前的元素

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

setListId(listItem)

設定清單 ID。

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

參數

名稱類型說明
listItemListItem要使用的清單 ID 清單項目

Return 鍵

ListItem:目前的元素

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

setNestingLevel(nestingLevel)

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

根據預設,清單項目的巢狀層級為零。巢狀層級會決定清單項目使用的字符。

參數

名稱類型說明
nestingLevelInteger巢狀層級

Return 鍵

ListItem:目前的元素

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

setSpacingAfter(spacingAfter)

設定元素之後的間距。

參數

名稱類型說明
spacingAfterNumber元素之後的間距

Return 鍵

ListItem:目前的元素

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

setSpacingBefore(spacingBefore)

設定元素前後的間距。

參數

名稱類型說明
spacingBeforeNumber元素前面的間距

Return 鍵

ListItem:目前的元素

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

setText(text)

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

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

參數

名稱類型說明
textString新文字內容

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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

setTextAlignment(textAlignment)

設定文字對齊方式。可用的對齊類型為 DocumentApp.TextAlignment.NORMALDocumentApp.TextAlignment.SUBSCRIPTDocumentApp.TextAlignment.SUPERSCRIPT

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

參數

名稱類型說明
textAlignmentTextAlignment要套用的文字對齊類型

Return 鍵

ListItem:目前的元素

授權

如果指令碼使用這個方法,就必須符合下列一或多個範圍的授權:

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