Class 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()

以適合向使用者顯示的格式，傳回由相關聯圖形或表格儲存格此範圍所界定的算繪文字。

自動文字元素 (例如產生的投影片號碼) 會替換成算繪值。範圍內的任何非文字元素都會省略。

回攻員

String

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

asString()

傳回由相關形狀或表格儲存格這個範圍所界定的原始文字。

Auto文字元素 (例如產生的投影片編號) 和範圍內的任何非文字元素，都會替換為 Unicode 字元 U+E907。

回攻員

String

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

clear()

清除這個範圍內的文字。

由於形狀或表格單元格中的整個文字必須以換行符號結尾，因此系統不會移除文字中的最後一個換行符號。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

  • 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 相對應的文字範圍集合。

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

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

// Accesses the first link on a TextRange object.
const textRange = SlidesApp.getActivePresentation().getSlides()[0].getShapes()[0].getText();
const linkTextRange = textRange.getLinks()[0];
const textStyle = linkTextRange.getTextStyle();
Logger.log(textStyle.hasLink());   // logs 'true'
const 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 或 TableCell 的父項 Page 會設為 current page selection。Shape 或 TableCell 會設為 selected page element。

    Selection 有兩種類型：
    • 1. 文字範圍，請選取非空白的 TextRange，以便選取字元範圍。
    • 2. 游標位置，使用空白的 TextRange 將游標放在所需索引。
      const 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