Class TextRange

TextRange

Shape 或 TableCell 的文字內容區段。

如果您使用的方法會編輯文字在形狀中的配合效果，則會停用套用至形狀的任何自動調整設定。

方法

方法傳回類型簡短說明
appendParagraph(text)Paragraph在文字範圍結尾附加一個段落。
appendRange(textRange)TextRange將所提供文字範圍的副本附加到目前文字範圍的結尾處。
appendRange(textRange, matchSourceFormatting)TextRange將所提供文字範圍的副本附加到目前文字範圍的結尾處。
appendText(text)TextRange在文字範圍結尾處附加文字。
asRenderedString()String傳回由相關形狀或表格儲存格範圍限制的轉譯文字，並以適合向使用者顯示的格式。
asString()String傳回在相關形狀或表格儲存格中，這個範圍界限的原始文字。
clear()void清除受這個範圍限制的文字。
clear(startOffset, endOffset)void清除在範圍內開始與結束偏移範圍限制的文字。
find(pattern)TextRange[]傳回目前文字範圍內符合搜尋模式的所有範圍。
find(pattern, startOffset)TextRange[]從開始偏移開始，傳回目前文字範圍中符合搜尋模式的所有範圍。
getAutoTexts()AutoText[]傳回目前文字範圍內的自動文字。
getEndIndex()Integer傳回這個範圍中最後一個字元的不重複索引 (從 0 開始)。
getLength()Integer傳回這個範圍內的字元數。
getLinks()TextRange[]傳回與目前文字範圍中所有 Link 對應的文字範圍集合，或與目前文字範圍重疊。
getListParagraphs()Paragraph[]傳回清單中與目前文字範圍重疊的段落。
getListStyle()ListStyle傳回目前文字範圍的 ListStyle。
getParagraphStyle()ParagraphStyle傳回目前文字範圍的 ParagraphStyle。
getParagraphs()Paragraph[]傳回與目前文字範圍重疊的段落。
getRange(startOffset, endOffset)TextRange傳回新的 TextRange，其中包含其衍生範圍的部分。
getRuns()TextRange[]傳回與目前文字範圍重疊的文字執行作業。
getStartIndex()Integer傳回此範圍中第一個字元 (含 0 起算) 的索引。
getTextStyle()TextStyle傳回範圍的文字樣式；如果範圍為空白，則傳回 null。
insertParagraph(startOffset, text)Paragraph在起始偏移處插入段落。
insertRange(startOffset, textRange)TextRange在起始偏移處插入指定文字範圍的副本。
insertRange(startOffset, textRange, matchSourceFormatting)TextRange在起始偏移處插入指定文字範圍的副本。
insertText(startOffset, text)TextRange在起始偏移處插入文字。
isEmpty()Boolean如果這個範圍內沒有字元，會傳回 true，否則會傳回 false。
replaceAllText(findText, replaceText)Integer以取代文字取代所有符合搜尋文字的項目。
replaceAllText(findText, replaceText, matchCase)Integer以取代文字取代所有符合搜尋文字的項目。
select()void只選取使用中簡報中的 TextRange，並移除先前的所有選取項目。
setText(newText)TextRange設定相關形狀或表格儲存格的指定文字範圍。

內容詳盡的說明文件

appendParagraph(text)

在文字範圍結尾附加一個段落。段落會沿用目前文字範圍的樣式。

提供的文字字串須附加在字串中至少一個換行字元。

如果提供的文字字串包含換行字元 (由多個段落組成)，系統會傳回加入的最終段落。

參數

名稱類型說明
textString要附加為段落的字串。

回攻員

Paragraph：附加的 Paragraph。

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權：

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

appendRange(textRange)

將所提供文字範圍的副本附加到目前文字範圍的結尾處。

插入文字的格式設定會與來源文字一致。

參數

名稱類型說明
textRangeTextRange要附加的文字範圍。

回攻員

TextRange：代表附加文字的文字範圍

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權：

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

appendRange(textRange, matchSourceFormatting)

將所提供文字範圍的副本附加到目前文字範圍的結尾處。

如果設定為符合目的地文字的格式，則指定文字範圍內的 AutoText 會替換為轉譯值。此外，系統不會附加指定文字範圍中的任何非文字元素。

參數

名稱類型說明
textRangeTextRange要附加的文字範圍。
matchSourceFormattingBoolean如為 true，則與來源文字的格式相符；如果是 false，則與目的地文字的格式相符。

回攻員

TextRange：代表附加文字的文字範圍

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權：

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

appendText(text)

在文字範圍結尾處附加文字。文字會沿用現有文字結尾的樣式。

參數

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

回攻員

TextRange：代表附加文字的文字範圍。

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權：

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

asRenderedString()

傳回由相關形狀或表格儲存格範圍所界限的轉譯文字，並以適合向使用者顯示的格式。

AutoText 元素 (例如產生的投影片編號) 會替換為轉譯值。範圍中的任何非文字元素都會省略。

回攻員

String

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權：

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

asString()

傳回在相關形狀或表格儲存格中，這個範圍界限的原始文字。

AutoText 元素 (例如產生的投影片編號和範圍內的任何非文字元素) 會取代為萬國碼 (Unicode) 字元 U+E907。

回攻員

String

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權：

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

clear()

清除受這個範圍限制的文字。

由於形狀或 TableCell 中的整個文字必須以換行方式結尾，系統不會移除文字中最後的換行符號。

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權：

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

clear(startOffset, endOffset)

清除在範圍內開始和結束偏移範圍限制的文字。

由於文字必須以換行符號結尾，因此系統不會移除文字最後的換行符號，即使位於指定的偏移範圍也一樣。

參數

名稱類型說明
startOffsetInteger目前文字範圍起始索引的字元數，用於決定要清除範圍中納入範圍的起始索引。起始位移必須等於或大於 0 且小於或等於 endOffset。startOffset 也不得小於目前範圍的長度。
endOffsetInteger目前文字範圍起始索引的字元數，用於決定要清除範圍的專屬結束索引。endOffset 必須等於或大於 startOffset。「endOffset」也必須小於或等於目前範圍的長度。

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權：

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

find(pattern)

傳回目前文字範圍內符合搜尋模式的所有範圍。搜尋有大小寫之分。

參數

名稱類型說明
patternString要搜尋的規則運算式模式；模式中的所有反斜線均應逸出。

回攻員

TextRange[]

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權：

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

find(pattern, startOffset)

從開始偏移開始，傳回目前文字範圍中符合搜尋模式的所有範圍。搜尋有大小寫之分。

參數

名稱類型說明
patternString要搜尋的規則運算式模式；模式中的所有反斜線均應逸出。
startOffsetInteger目前文字範圍起始索引的字元數，用於決定搜尋範圍的包含開始索引。startOffset 也必須小於目前範圍的長度。

回攻員

TextRange[]

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權：

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

getAutoTexts()

傳回目前文字範圍內的自動文字。

回攻員

AutoText[]

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權：

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

getEndIndex()

傳回這個範圍中最後一個字元的不重複索引 (從 0 開始)。如果起始索引和結束索引相等，則該範圍會視為空白。

回攻員

Integer

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權：

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

getLength()

傳回這個範圍內的字元數。

回攻員

Integer

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權：

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

傳回與目前文字範圍中所有 Link 對應的文字範圍集合，或與目前文字範圍重疊。

每個傳回的範圍在建立時保證會跨越一個連結。文字修改可能會導致系統不再僅代表一個連結。

傳回範圍中的每個 Link 都可以透過 TextStyle.getLink() 存取。

// Accesses the first link on a TextRange object.
var linkTextRange = textRange.getLinks()[0];
var textStyle = linkTextRange.getTextStyle();
Logger.log(textStyle.hasLink()); // logs 'true'
var link = textStyle.getLink();  // Link object

回攻員

TextRange[]

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權：

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

getListParagraphs()

傳回清單中與目前文字範圍重疊的段落。

回攻員

Paragraph[]

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權：

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

getListStyle()

傳回目前文字範圍的 ListStyle。

回攻員

ListStyle

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權：

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

getParagraphStyle()

傳回目前文字範圍的 ParagraphStyle。

回攻員

ParagraphStyle

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權：

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

getParagraphs()

傳回與目前文字範圍重疊的段落。

回攻員

Paragraph[]

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權：

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

getRange(startOffset, endOffset)

傳回新的 TextRange，其中包含其衍生範圍的部分。

參數

名稱類型說明
startOffsetInteger目前文字範圍起始索引的字元數，用來決定傳回範圍的包含開始索引。起始位移必須等於或大於 0 且小於或等於 endOffset。startOffset 也不得小於目前範圍的長度。
endOffsetInteger超過目前文字範圍起始索引的字元數，用來決定傳回範圍的專屬結束索引。endOffset 必須等於或大於 startOffset。「endOffset」也必須小於或等於目前範圍的長度。

回攻員

TextRange

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權：

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

getRuns()

傳回與目前文字範圍重疊的文字執行作業。文字執行是一段文字，其中所有字元都採用相同的文字樣式。

每個傳回的範圍只會在建立時保證執行一次。文字或樣式修改可能會導致訊息不再代表執行一次。

回攻員

TextRange[]

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權：

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

getStartIndex()

傳回此範圍中第一個字元 (含 0 起算) 的索引。如果起始索引和結束索引相等，系統會將範圍視為空白。

回攻員

Integer

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權：

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

getTextStyle()

傳回範圍的文字樣式；如果範圍為空白，則傳回 null。

回攻員

TextStyle

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權：

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

insertParagraph(startOffset, text)

在起始偏移處插入段落。段落會在起始偏移時保留目前文字範圍的樣式。

系統會在字串中至少加上一個換行字元，將提供的文字字串插入為段落。

如果提供的文字字串包含換行字元 (由多個段落組成)，系統會傳回加入的最終段落。

參數

名稱類型說明
startOffsetInteger目前文字範圍起始索引的字元數，用於決定要插入的文字 (包含首尾) 索引。
textString要插入的字串。

回攻員

Paragraph：插入的 Paragraph。

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權：

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

insertRange(startOffset, textRange)

在起始偏移處插入指定文字範圍的副本。

插入文字的格式設定會與來源文字一致。

參數

名稱類型說明
startOffsetInteger目前文字範圍起始索引的字元數，用於決定要插入的文字 (包含首尾) 索引。
textRangeTextRange要插入的文字範圍。

回攻員

TextRange：代表插入文字的文字範圍

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權：

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

insertRange(startOffset, textRange, matchSourceFormatting)

在起始偏移處插入指定文字範圍的副本。

如果設定為符合目的地文字的格式，則指定文字範圍內的 AutoText 會替換為轉譯值。此外，系統不會插入指定文字範圍內的任何非文字元素。

參數

名稱類型說明
startOffsetInteger目前文字範圍起始索引的字元數，用於決定要插入的文字 (包含首尾) 索引。
textRangeTextRange要插入的文字範圍。
matchSourceFormattingBoolean如為 true，則與來源文字的格式相符；如果是 false，則與目的地文字的格式相符。

回攻員

TextRange：代表插入文字的文字範圍

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權：

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

insertText(startOffset, text)

在起始偏移處插入文字。文字會在起始偏移時保留現有文字的樣式。

參數

名稱類型說明
startOffsetInteger目前文字範圍起始索引的字元數，用於決定要插入的文字 (包含首尾) 索引。
textString要插入的字串。

回攻員

TextRange：代表插入文字的文字範圍。

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權：

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

isEmpty()

如果這個範圍內沒有字元，會傳回 true，否則會傳回 false。

回攻員

Boolean

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權：

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

replaceAllText(findText, replaceText)

以取代文字取代所有符合搜尋文字的項目。搜尋不區分大小寫。

參數

名稱類型說明
findTextString要尋找的文字。
replaceTextString要取代相符文字的文字。

回攻員

Integer：變更的重複次數

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權：

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

replaceAllText(findText, replaceText, matchCase)

以取代文字取代所有符合搜尋文字的項目。

參數

名稱類型說明
findTextString要尋找的文字。
replaceTextString要取代相符文字的文字。
matchCaseBoolean如果值為 true，則搜尋會區分大小寫；如果值為 false，則搜尋不區分大小寫。

回攻員

Integer：變更的重複次數

授權

使用這個方法的指令碼必須取得以下一或多個範圍的授權：

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

select()

只選取使用中簡報中的 TextRange，並移除先前的所有選取項目。

指令碼只有在指令碼繫結至簡報時，才能存取執行指令碼的使用者選取項目。

對應 Shape 的父項 Page 或 TableCell 設為 current page selection。Shape 或 TableCell 設為 selected page element。

    Selection 可分為兩種類型：
    • 1. 文字範圍，請在非空白的 TextRange 上使用選取項目來選取字元範圍。
    • 2. 遊標位置，使用空白的 TextRange 將遊標放在想要的索引上。
      var shape = SlidesApp.getActivePresentation().getSlides()[0].getShapes()[0];
shape.getText().setText("Hello");
// Range selection: Select the text range "He".
shape.getText().getRange(0, 2).select();
// Cursor selection: Place the cursor after "H" like "H|ello".
shape.getText().getRange(1, 1).select();

      授權

      使用這個方法的指令碼必須取得以下一或多個範圍的授權：

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

    setText(newText)

    設定相關形狀或表格儲存格的指定文字範圍。並保留現有文字開頭的樣式。

    參數

    名稱類型說明
    newTextString要設為新文字的字串。

    回攻員

    TextRange：代表設定文字的文字範圍

    授權

    使用這個方法的指令碼必須取得以下一或多個範圍的授權：

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