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 開始) 的索引 (從 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()

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

由於 Shape 或 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 開始的索引 (從 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 或 TableCell 已設定父項 Page 做為 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