Class Body

內文

Google 文件分頁內容。Body 可能包含 ListItem、 Paragraph、Table 和 TableOfContents 元素。如要進一步瞭解 文件結構，請參閱這份指南 為 Google 文件調度資源

Body 通常包含整個分頁的內容，但 HeaderSection、FooterSection 和任何 FootnoteSection 元素除外。 

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

// Append a paragraph and a page break to the tab's body section directly.
body.appendParagraph("A paragraph.");
body.appendPageBreak();

方法

方法傳回類型簡短說明
appendHorizontalRule()HorizontalRule建立並附加新的 HorizontalRule。
appendImage(image)InlineImage從指定的圖片 blob 建立及附加新的 InlineImage。
appendImage(image)InlineImage附加指定的 InlineImage。
appendListItem(listItem)ListItem附加指定的 ListItem。
appendListItem(text)ListItem建立並附加含有指定文字內容的新 ListItem。
appendPageBreak()PageBreak建立並附加新的 PageBreak。
appendPageBreak(pageBreak)PageBreak附加指定的 PageBreak。
appendParagraph(paragraph)Paragraph附加指定的 Paragraph。
appendParagraph(text)Paragraph建立並附加含有指定文字內容的新 Paragraph。
appendTable()Table建立並附加新的 Table。
appendTable(cells)Table針對每個指定字串值，附加含有 TableCell 的新 Table。
appendTable(table)Table附加指定的 Table。
clear()Body清除元素內容。
copy()Body傳回目前元素的卸離的深度副本。
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擷取指定子元素的子索引。
getHeadingAttributes(paragraphHeading)Object擷取所提供 ParagraphHeading 的一組屬性。
getImages()InlineImage[]擷取該區段包含的所有 InlineImages。
getListItems()ListItem[]擷取該區段包含的所有 ListItems。
getMarginBottom()Number擷取底部邊界。
getMarginLeft()Number擷取左邊界 (以點表示)。
getMarginRight()Number擷取右側邊界。
getMarginTop()Number擷取上邊界。
getNumChildren()Integer擷取子發布商數量。
getPageHeight()Number擷取頁面高度 (以點表示)。
getPageWidth()Number擷取頁面寬度 (以點為基準)。
getParagraphs()Paragraph[]擷取區段包含的所有 Paragraphs (包括 ListItems)。
getParent()ContainerElement擷取元素的父項元素。
getTables()Table[]擷取該區段包含的所有 Tables。
getText()String以文字字串形式擷取元素內容。
getTextAlignment()TextAlignment取得文字對齊方式。
getType()ElementType擷取元素的 ElementType。
insertHorizontalRule(childIndex)HorizontalRule在指定索引建立並插入新的 HorizontalRule。
insertImage(childIndex, image)InlineImage從指定的圖片 blob 建立並插入 InlineImage，位於指定的 索引。
insertImage(childIndex, image)InlineImage在指定的索引插入指定的 InlineImage。
insertListItem(childIndex, listItem)ListItem在指定的索引插入指定的 ListItem。
insertListItem(childIndex, text)ListItem在指定索引建立並插入新的 ListItem，其中包含指定的索引 例如文字內容，
insertPageBreak(childIndex)PageBreak在指定索引建立並插入新的 PageBreak。
insertPageBreak(childIndex, pageBreak)PageBreak在指定的索引插入指定的 PageBreak。
insertParagraph(childIndex, paragraph)Paragraph在指定的索引插入指定的 Paragraph。
insertParagraph(childIndex, text)Paragraph在指定索引建立並插入新的 Paragraph，其中包含指定的索引 例如文字內容，
insertTable(childIndex)Table在指定索引建立並插入新的 Table。
insertTable(childIndex, cells)Table在指定索引建立並插入含有指定儲存格的新 Table。
insertTable(childIndex, table)Table在指定的索引插入指定的 Table。
removeChild(child)Body移除指定的子元素。
replaceText(searchPattern, replacement)Element使用一般的 運算式。
setAttributes(attributes)Body設定元素的屬性。
setHeadingAttributes(paragraphHeading, attributes)Body設定所提供 ParagraphHeading 的屬性。
setMarginBottom(marginBottom)Body設定底部邊界 (以點為單位)。
setMarginLeft(marginLeft)Body設定左邊界 (以點表示)。
setMarginRight(marginRight)Body設定右邊界 (以點為單位)。
setMarginTop(marginTop)Body設定上邊界。
setPageHeight(pageHeight)Body設定頁面高度 (以點表示)。
setPageWidth(pageWidth)Body設定頁面寬度 (以點表示)。
setText(text)Body將內容設為純文字。
setTextAlignment(textAlignment)Body設定文字對齊方式。

內容詳盡的說明文件

appendHorizontalRule()

建立並附加新的 HorizontalRule。

HorizontalRule 會包含在新的 Paragraph 中。

回攻員

HorizontalRule：新的水平規則。

授權

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

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

appendImage(image)

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

圖片將包含在新的 Paragraph 中。

參數

名稱類型說明
imageBlobSource圖片資料。

回攻員

InlineImage：附加的圖片。

授權

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

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

appendImage(image)

附加指定的 InlineImage。

InlineImage 會包含在新的 Paragraph 中。

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

參數

名稱類型說明
imageInlineImage圖片資料。

回攻員

InlineImage：附加的圖片。

授權

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

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

appendListItem(listItem)

附加指定的 ListItem。

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

參數

名稱類型說明
listItemListItem要附加的清單項目。

回攻員

ListItem：附加的清單項目，

授權

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

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

appendListItem(text)

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

連續的清單項目會合併至同一份清單中。

參數

名稱類型說明
textString清單項目的文字內容。

回攻員

ListItem：新的清單項目，

授權

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

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

appendPageBreak()

建立並附加新的 PageBreak。

PageBreak 會包含在新的 Paragraph 中。

回攻員

PageBreak：新的分頁符號。

授權

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

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

appendPageBreak(pageBreak)

附加指定的 PageBreak。

PageBreak 會包含在新的 Paragraph 中。

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

參數

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

回攻員

PageBreak：附加的分頁符號。

授權

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

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

appendParagraph(paragraph)

附加指定的 Paragraph。

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

參數

名稱類型說明
paragraphParagraph要附加的段落。

回攻員

Paragraph：附加段落。

授權

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

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

appendParagraph(text)

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

參數

名稱類型說明
textString段落的文字內容。

回攻員

Paragraph - 新段落。

授權

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

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

appendTable()

建立並附加新的 Table。

這個方法也會在表格後方附加一個空白段落，因為 Google 文件 結尾不得為表格。

回攻員

Table：新的資料表。

授權

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

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

appendTable(cells)

針對每個指定字串值，附加含有 TableCell 的新 Table。

這個方法也會在表格後方附加一個空白段落，因為 Google 文件 結尾不得為表格。

參數

名稱類型說明
cellsString[][]要加入新表格的表格儲存格文字內容。

回攻員

Table：附加的資料表。

授權

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

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

appendTable(table)

附加指定的 Table。

附加現有的 Table 副本時，請使用這個版本的 appendTable。 這個方法也會在表格後方附加一個空白段落，因為 Google 文件 結尾不得為表格。

參數

名稱類型說明
tableTable要附加的資料表。

回攻員

Table：附加的資料表。

授權

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

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

clear()

清除元素內容。

回攻員

Body：目前的元素。

copy()

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

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

回攻員

Body：新的副本。

授權

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

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

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

參數

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

回攻員

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

參數

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

回攻員

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

授權

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

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

findText(searchPattern)

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

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

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

參數

名稱類型說明
searchPatternString也就是搜尋的模式

回攻員

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

授權

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

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

findText(searchPattern, from)

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

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

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

參數

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

回攻員

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.");
}

參數

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

回攻員

Element：指定索引的子元素。

授權

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

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

getChildIndex(child)

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

參數

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

回攻員

Integer：子索引。

授權

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

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

getHeadingAttributes(paragraphHeading)

擷取所提供 ParagraphHeading 的一組屬性。

參數

名稱類型說明
paragraphHeadingParagraphHeading應擷取其屬性的標題。

回攻員

Object：屬性及其目前值的對應。

授權

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

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

getImages()

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

回攻員

InlineImage[]：版面圖片，

授權

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

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

getListItems()

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

回攻員

ListItem[]：版面清單項目。

授權

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

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

getMarginBottom()

擷取底部邊界。

回攻員

Number：底部邊界，以點數表示。

授權

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

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

getMarginLeft()

擷取左邊界 (以點表示)。

回攻員

Number：左邊界，以點表示。

授權

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

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

getMarginRight()

擷取右側邊界。

回攻員

Number：右邊界，以點表示。

授權

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

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

getMarginTop()

擷取上邊界。

回攻員

Number：頂部邊界，以點數表示。

授權

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

  • 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

getPageHeight()

擷取頁面高度 (以點表示)。

回攻員

Number：頁面高度，以點表示。

授權

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

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

getPageWidth()

擷取頁面寬度 (以點為基準)。

回攻員

Number：頁面寬度，以點表示。

授權

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

  • 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

getTables()

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

回攻員

Table[]：區段表格，

授權

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

  • 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。

HorizontalRule 會包含在新的 Paragraph 中。

參數

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

回攻員

HorizontalRule：新的水平規則。

授權

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

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

insertImage(childIndex, image)

從指定的圖片 blob 建立並插入 InlineImage，位於指定的 索引。

參數

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

回攻員

InlineImage：插入的內嵌圖片。

授權

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

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

insertImage(childIndex, image)

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

圖片將包含在新的 Paragraph 中。

參數

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

回攻員

InlineImage：插入的內嵌圖片。

授權

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

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

insertListItem(childIndex, listItem)

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

參數

名稱類型說明
childIndexInteger要插入的索引。
listItemListItem要插入的清單項目。

回攻員

ListItem：插入的清單項目。

授權

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

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

insertListItem(childIndex, text)

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

參數

名稱類型說明
childIndexInteger要插入的索引。
textString清單項目的文字內容。

回攻員

ListItem：新的清單項目，

授權

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

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

insertPageBreak(childIndex)

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

PageBreak 會包含在新的 Paragraph 中。

參數

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

回攻員

PageBreak：新的分頁符號。

授權

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

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

insertPageBreak(childIndex, pageBreak)

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

PageBreak 會包含在新的 Paragraph 中。

參數

名稱類型說明
childIndexInteger要插入元素的索引。
pageBreakPageBreak要插入的分頁符號。

回攻員

PageBreak：插入的分頁符號。

授權

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

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

insertParagraph(childIndex, paragraph)

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

參數

名稱類型說明
childIndexInteger要插入的索引。
paragraphParagraph要插入的段落。

回攻員

Paragraph：插入的段落。

授權

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

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

insertParagraph(childIndex, text)

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

參數

名稱類型說明
childIndexInteger要插入的索引。
textString段落的文字內容。

回攻員

Paragraph - 新段落。

授權

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

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

insertTable(childIndex)

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

參數

名稱類型說明
childIndexInteger要插入的索引。

回攻員

Table：新的資料表。

授權

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

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

insertTable(childIndex, cells)

在指定索引建立並插入含有指定儲存格的新 Table。

參數

名稱類型說明
childIndexInteger要插入的索引。
cellsString[][]要加入新表格的表格儲存格文字內容。

回攻員

Table：新的資料表。

授權

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

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

insertTable(childIndex, table)

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

參數

名稱類型說明
childIndexInteger要插入的索引。
tableTable要插入的表格。

回攻員

Table：插入的資料表。

授權

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

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

removeChild(child)

移除指定的子元素。

參數

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

回攻員

Body：目前的元素。

授權

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

  • 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");

參數

名稱類型說明
searchPatternString要搜尋的規則運算式模式
replacementString要用於取代的文字

回攻員

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

參數

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

回攻員

Body：目前的元素。

授權

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

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

setHeadingAttributes(paragraphHeading, attributes)

設定所提供 ParagraphHeading 的屬性。

參數

名稱類型說明
paragraphHeadingParagraphHeading應設定屬性的標題。
attributesObject屬性和其設定值的對應。

回攻員

Body：目前的元素。

授權

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

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

setMarginBottom(marginBottom)

設定底部邊界 (以點為單位)。

參數

名稱類型說明
marginBottomNumber底部邊界，以點數表示。

回攻員

Body：目前的元素。

授權

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

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

setMarginLeft(marginLeft)

設定左邊界 (以點表示)。

參數

名稱類型說明
marginLeftNumber左邊界，以點表示。

回攻員

Body：目前的元素。

授權

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

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

setMarginRight(marginRight)

設定右邊界 (以點為單位)。

參數

名稱類型說明
marginRightNumber右邊界。

回攻員

Body：目前的元素。

授權

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

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

setMarginTop(marginTop)

設定上邊界。

參數

名稱類型說明
marginTopNumber頂端邊界，以點數表示。

回攻員

Body：目前的元素。

授權

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

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

setPageHeight(pageHeight)

設定頁面高度 (以點表示)。

參數

名稱類型說明
pageHeightNumber頁面高度 (以點表示)。

回攻員

Body：目前的元素。

授權

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

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

setPageWidth(pageWidth)

設定頁面寬度 (以點表示)。

參數

名稱類型說明
pageWidthNumber頁面寬度 (以點表示)。

回攻員

Body：目前的元素。

授權

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

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

setText(text)

將內容設為純文字。

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

參數

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

回攻員

Body：目前的元素。

授權

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

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

參數

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

回攻員

Body：目前的元素

授權

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

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

已淘汰的方法