Class Text

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

代表複合式文字區域的元素。Document 中的所有文字都包含在 Text 元素中。Text 元素可以包含在 EquationEquationFunctionListItemParagraph 中,但本身不得包含任何其他元素。如要進一步瞭解文件結構,請參閱擴充 Google 文件的指南

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

// Use editAsText to obtain a single text element containing
// all the characters in the document.
var text = body.editAsText();

// Insert text at the beginning of the document.
text.insertText(0, 'Inserted text.\n');

// Insert text at the end of the document.
text.appendText('\nAppended text.');

// Make the first half of the document blue.
text.setForegroundColor(0, text.getText().length / 2, '#00FFFF');

方法

方法傳回類型簡短說明
appendText(text)Text將指定文字新增至這個文字區域的結尾。
copy()Text傳回目前元素的卸離深層連結。
deleteText(startOffset, endOffsetInclusive)Text刪除特定文字範圍。
editAsText()Text取得目前元素的 Text 版本以進行編輯。
findText(searchPattern)RangeElement使用規則運算式搜尋元素中的文字內容。
findText(searchPattern, from)RangeElement從指定搜尋結果中,搜尋指定文字模式的元素內容。
getAttributes()Object擷取元素的屬性。
getAttributes(offset)Object擷取指定字元偏移的屬性。
getBackgroundColor()String擷取背景顏色設定。
getBackgroundColor(offset)String擷取指定字元偏移的背景顏色。
getFontFamily()String擷取字型系列設定。
getFontFamily(offset)String擷取指定字元偏移的字型系列。
getFontSize()Number擷取字型大小設定。
getFontSize(offset)Number擷取指定字元偏移的字型大小。
getForegroundColor()String擷取前景色彩設定。
getForegroundColor(offset)String擷取指定字元偏移時的前景顏色。
getLinkUrl()String擷取連結網址。
getLinkUrl(offset)String擷取指定字元偏移的連結網址。
getNextSibling()Element擷取元素和下一個下一個同層級元素。
getParent()ContainerElement擷取元素的父項元素。
getPreviousSibling()Element擷取元素的先前同層級元素。
getText()String以文字字串的形式擷取元素內容。
getTextAlignment()TextAlignment取得文字對齊方式。
getTextAlignment(offset)TextAlignment取得單一字元的文字對齊方式。
getTextAttributeIndices()Integer[]擷取一組與不同文字格式設定執行作業開始的文字索引。
getType()ElementType擷取元素的 ElementType
insertText(offset, text)Text依據指定的字元偏移插入指定文字。
isAtDocumentEnd()Boolean判斷元素是否位於 Document 的結尾。
isBold()Boolean擷取粗體設定。
isBold(offset)Boolean擷取指定字元偏移時的粗體設定。
isItalic()Boolean擷取斜體設定。
isItalic(offset)Boolean擷取指定字元偏移的斜體設定。
isStrikethrough()Boolean擷取刪除線設定。
isStrikethrough(offset)Boolean擷取指定字元偏移時的刪除線設定。
isUnderline()Boolean擷取底線設定。
isUnderline(offset)Boolean擷取指定字元偏移的底線設定。
merge()Text將元素與前相同類型的同層級合併。
removeFromParent()Text從父項中移除元素。
replaceText(searchPattern, replacement)Element使用規則運算式將特定文字模式的所有出現情況替換為特定替代字串。
setAttributes(startOffset, endOffsetInclusive, attributes)Text將指定的屬性套用至指定的字元範圍。
setAttributes(attributes)Text設定元素的屬性。
setBackgroundColor(startOffset, endOffsetInclusive, color)Text設定指定字元範圍的背景顏色。
setBackgroundColor(color)Text設定背景顏色。
setBold(bold)Text套用粗體設定。
setBold(startOffset, endOffsetInclusive, bold)Text設定指定字元範圍的粗體設定。
setFontFamily(startOffset, endOffsetInclusive, fontFamilyName)Text設定指定半形字元的字型系列。
setFontFamily(fontFamilyName)Text設定字型系列。
setFontSize(startOffset, endOffsetInclusive, size)Text設定指定半形字元的字型大小。
setFontSize(size)Text設定字型大小。
setForegroundColor(startOffset, endOffsetInclusive, color)Text設定指定字元範圍的前景顏色。
setForegroundColor(color)Text設定前景顏色。
setItalic(italic)Text設定斜體設定。
setItalic(startOffset, endOffsetInclusive, italic)Text用於設定指定字元範圍的斜體設定。
setLinkUrl(startOffset, endOffsetInclusive, url)Text設定指定字元範圍的連結網址。
setLinkUrl(url)Text設定連結網址。
setStrikethrough(strikethrough)Text設定刪除線設定。
setStrikethrough(startOffset, endOffsetInclusive, strikethrough)Text設定指定字元範圍的刪除線設定。
setText(text)Text設定文字內容。
setTextAlignment(startOffset, endOffsetInclusive, textAlignment)Text設定指定半形字元的文字對齊方式。
setTextAlignment(textAlignment)Text設定文字對齊方式。
setUnderline(underline)Text設定底線設定。
setUnderline(startOffset, endOffsetInclusive, underline)Text設定指定半形字元範圍的底線設定。

內容詳盡的說明文件

appendText(text)

將指定文字新增至這個文字區域的結尾。

參數

名稱類型說明
textString要附加的文字

Return 鍵

Text:目前的元素

授權

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

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

copy()

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

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

Return 鍵

Text — 新副本。

授權

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

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

deleteText(startOffset, endOffsetInclusive)

刪除特定文字範圍。

參數

名稱類型說明
startOffsetInteger第一個要刪除的字元的偏移值
endOffsetInclusiveInteger要刪除的最後一個字元的字元偏移

Return 鍵

Text:目前的元素

授權

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

  • 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:目前元素的文字版本


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

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

getAttributes(offset)

擷取指定字元偏移的屬性。

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

參數

名稱類型說明
offsetInteger字元偏移

Return 鍵

Object — 元素的屬性

授權

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

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

getBackgroundColor()

擷取背景顏色設定。

Return 鍵

String:以 CSS 標記法表示的背景顏色 (例如 '#ffffff')。如果元素包含多個屬性,則為空值

授權

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

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

getBackgroundColor(offset)

擷取指定字元偏移的背景顏色。

參數

名稱類型說明
offsetInteger字元偏移

Return 鍵

String:以 CSS 標記法表示的背景顏色 (例如 '#ffffff')

授權

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

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

getFontFamily()

擷取字型系列設定。名稱可以是 Google 文件字型字型中的任何字型,或是 Google Fonts (區分大小寫)。getFontFamily()setFontFamily(fontFamilyName) 方法現在使用字型的字串名稱,而不是 FontFamily 列舉。雖然這個列舉已淘汰,但仍可用於與舊版指令碼相容。

Return 鍵

String:字型系列,如果元素包含多個屬性的值,則傳回空值

授權

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

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

getFontFamily(offset)

擷取指定字元偏移的字型系列。名稱可以是 Google 文件字型選單中的任何字型,或是 Google Fonts (區分大小寫)。getFontFamily()setFontFamily(fontFamilyName) 方法現在會使用字型字串名稱,而不是 FontFamily 列舉。雖然這個列舉已淘汰,但仍可用於與舊版指令碼相容。

參數

名稱類型說明
offsetInteger字元偏移

Return 鍵

String:字型系列

授權

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

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

getFontSize()

擷取字型大小設定。

Return 鍵

Number:字型大小,如果元素包含多個屬性,則傳回空值

授權

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

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

getFontSize(offset)

擷取指定字元偏移的字型大小。

參數

名稱類型說明
offsetInteger字元偏移

Return 鍵

Number:字型大小

授權

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

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

getForegroundColor()

擷取前景色彩設定。

Return 鍵

String:前景顏色,格式為 CSS 標記 (例如 '#ffffff'),如果元素包含多個屬性,則設為空值

授權

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

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

getForegroundColor(offset)

擷取指定字元偏移時的前景顏色。

參數

名稱類型說明
offsetInteger字元偏移

Return 鍵

String:前景顏色,以 CSS 標記法表示 (例如 '#ffffff')

授權

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

  • 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

getLinkUrl(offset)

擷取指定字元偏移的連結網址。

參數

名稱類型說明
offsetInteger字元偏移

Return 鍵

String:連結網址

授權

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

  • 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

getParent()

擷取元素的父項元素。

父項元素包含目前元素。

Return 鍵

ContainerElement:父項元素。

授權

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

  • 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

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

getTextAlignment(offset)

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

參數

名稱類型說明
offsetInteger字元偏移

Return 鍵

TextAlignment:文字對齊方式類型;如果未設定文字對齊方式,則為 null

授權

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

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

getTextAttributeIndices()

擷取一組與不同文字格式設定執行作業開始的文字索引。

Return 鍵

Integer[]:文字格式變更的文字索引組合

授權

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

  • 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

insertText(offset, text)

依據指定的字元偏移插入指定文字。

參數

名稱類型說明
offsetInteger插入位置的字元偏移
textString要插入的文字

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

isBold()

擷取粗體設定。

Return 鍵

Boolean:文字為粗體,如果元素包含多個屬性,則設為空值

授權

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

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

isBold(offset)

擷取指定字元偏移時的粗體設定。

參數

名稱類型說明
offsetInteger字元偏移

Return 鍵

Boolean:粗體設定

授權

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

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

isItalic()

擷取斜體設定。

Return 鍵

Boolean:文字是斜體,如果元素包含多個屬性,則傳回空值

授權

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

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

isItalic(offset)

擷取指定字元偏移的斜體設定。

參數

名稱類型說明
offsetInteger字元偏移

Return 鍵

Boolean:斜體設定

授權

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

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

isStrikethrough()

擷取刪除線設定。

Return 鍵

Boolean:文字是否加上刪除線。如果元素包含多個屬性,則傳回空值

授權

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

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

isStrikethrough(offset)

擷取指定字元偏移時的刪除線設定。

參數

名稱類型說明
offsetInteger字元偏移

Return 鍵

Boolean:刪除線設定

授權

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

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

isUnderline()

擷取底線設定。

Return 鍵

Boolean:表示文字是否加上底線;如果元素包含多個屬性,則傳回空值

授權

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

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

isUnderline(offset)

擷取指定字元偏移的底線設定。

參數

名稱類型說明
offsetInteger字元偏移

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 鍵

Text — 合併的元素。

授權

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

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

Text — 移除的元素。

授權

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

  • 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

setAttributes(startOffset, endOffsetInclusive, attributes)

將指定屬性套用至指定的字元範圍。

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

參數

名稱類型說明
startOffsetInteger文字範圍的起始偏移
endOffsetInclusiveInteger文字範圍的結束偏移
attributesObject元素的屬性

Return 鍵

Text:目前的元素

授權

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

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

Text — 目前的元素。

授權

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

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

setBackgroundColor(startOffset, endOffsetInclusive, color)

設定指定字元範圍的背景顏色。

參數

名稱類型說明
startOffsetInteger文字範圍的起始偏移
endOffsetInclusiveInteger文字範圍的結束偏移
colorString採用 CSS 標記法的背景顏色 (例如 '#ffffff')

Return 鍵

Text:目前的元素

授權

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

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

setBackgroundColor(color)

設定背景顏色。

參數

名稱類型說明
colorString採用 CSS 標記法的背景顏色 (例如 '#ffffff')

Return 鍵

Text:目前的元素

授權

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

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

setBold(bold)

套用粗體設定。

參數

名稱類型說明
boldBoolean粗體設定

Return 鍵

Text:目前的元素

授權

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

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

setBold(startOffset, endOffsetInclusive, bold)

設定指定字元範圍的粗體設定。

參數

名稱類型說明
startOffsetInteger文字範圍的起始偏移
endOffsetInclusiveInteger文字範圍的結束偏移
boldBoolean粗體設定

Return 鍵

Text:目前的元素

授權

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

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

setFontFamily(startOffset, endOffsetInclusive, fontFamilyName)

設定指定半形字元的字型系列。名稱可以是 Google 文件的字型選單的任何字型,或是 Google 字型,並且區分大小寫。 無法辨識的字型名稱會顯示為 Arial。getFontFamily(offset)setFontFamily(fontFamilyName) 方法現在使用字型的字串名稱,而不是 FontFamily 列舉。雖然這個列舉已淘汰,但仍可用於與舊版指令碼相容。

參數

名稱類型說明
startOffsetInteger文字範圍的起始偏移
endOffsetInclusiveInteger文字範圍的結束偏移
fontFamilyNameString字型系列名稱 (擷取自 Google 文件的 [字型] 選單或 Google Fonts)

Return 鍵

Text:目前的元素

授權

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

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

setFontFamily(fontFamilyName)

設定字型系列。名稱可以是 Google 文件字型字型中的任何字型,或是 Google Fonts (區分大小寫)。無法辨識的字型名稱會顯示為 Arial。getFontFamily()setFontFamily(fontFamilyName) 方法現在使用字型的字串名稱,而非 FontFamily 列舉。雖然這個列舉已淘汰,但仍可用於與舊版指令碼相容。

參數

名稱類型說明
fontFamilyNameString字型系列名稱 (擷取自 Google 文件的 [字型] 選單或 Google Fonts)

Return 鍵

Text:目前的元素

授權

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

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

setFontSize(startOffset, endOffsetInclusive, size)

設定指定半形字元的字型大小。

參數

名稱類型說明
startOffsetInteger文字範圍的起始偏移
endOffsetInclusiveInteger文字範圍的結束偏移
sizeNumber字型大小

Return 鍵

Text:目前的元素

授權

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

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

setFontSize(size)

設定字型大小。

參數

名稱類型說明
sizeNumber字型大小

Return 鍵

Text:目前的元素

授權

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

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

setForegroundColor(startOffset, endOffsetInclusive, color)

設定指定字元範圍的前景顏色。

參數

名稱類型說明
startOffsetInteger文字範圍的起始偏移
endOffsetInclusiveInteger文字範圍的結束偏移
colorString前景顏色,格式為 CSS 標記格式 (例如 '#ffffff')

Return 鍵

Text:目前的元素

授權

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

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

setForegroundColor(color)

設定前景顏色。

參數

名稱類型說明
colorString前景顏色,格式為 CSS 標記格式 (例如 '#ffffff')

Return 鍵

Text:目前的元素

授權

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

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

setItalic(italic)

設定斜體設定。

參數

名稱類型說明
italicBoolean斜體設定

Return 鍵

Text:目前的元素

授權

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

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

setItalic(startOffset, endOffsetInclusive, italic)

用於設定指定字元範圍的斜體設定。

參數

名稱類型說明
startOffsetInteger文字範圍的起始偏移
endOffsetInclusiveInteger文字範圍的結束偏移
italicBoolean斜體設定

Return 鍵

Text:目前的元素

授權

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

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

setLinkUrl(startOffset, endOffsetInclusive, url)

設定指定字元範圍的連結網址。

參數

名稱類型說明
startOffsetInteger文字範圍的起始偏移
endOffsetInclusiveInteger文字範圍的結束偏移
urlString連結網址

Return 鍵

Text:目前的元素

授權

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

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

setLinkUrl(url)

設定連結網址。

參數

名稱類型說明
urlString連結網址

Return 鍵

Text:目前的元素

授權

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

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

setStrikethrough(strikethrough)

設定刪除線設定。

參數

名稱類型說明
strikethroughBoolean刪除線設定

Return 鍵

Text:目前的元素

授權

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

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

setStrikethrough(startOffset, endOffsetInclusive, strikethrough)

設定指定字元範圍的刪除線設定。

參數

名稱類型說明
startOffsetInteger文字範圍的起始偏移
endOffsetInclusiveInteger文字範圍的結束偏移
strikethroughBoolean刪除線設定

Return 鍵

Text:目前的元素

授權

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

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

setText(text)

設定文字內容。

參數

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

Return 鍵

Text:目前的元素

授權

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

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

setTextAlignment(startOffset, endOffsetInclusive, textAlignment)

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

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

參數

名稱類型說明
startOffsetInteger字元範圍的起始位移
endOffsetInclusiveInteger字元範圍的結束位移 (含)
textAlignmentTextAlignment要套用的文字對齊類型

Return 鍵

Text:目前的元素

授權

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

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

Text:目前的元素

授權

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

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

setUnderline(underline)

設定底線設定。

參數

名稱類型說明
underlineBoolean底線設定

Return 鍵

Text:目前的元素

授權

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

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

setUnderline(startOffset, endOffsetInclusive, underline)

設定指定半形字元範圍的底線設定。

參數

名稱類型說明
startOffsetInteger文字範圍的起始偏移
endOffsetInclusiveInteger文字範圍的結束偏移
underlineBoolean底線設定

Return 鍵

Text:目前的元素

授權

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

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