本頁面由 Cloud Translation API 翻譯而成。

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

在文字範圍結尾附加段落。段落會維持目前文字範圍結尾的樣式。

提供的文字字串會附加為段落，方法是在字串中加入至少一個周圍的換行字元。

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

參數

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

回攻員

Paragraph— 附加的 Paragraph。

授權

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

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

`appendRange(textRange)`

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

插入文字的格式與來源文字的格式相符。

參數

名稱	類型	說明
`textRange`	`TextRange`	要附加的文字範圍。

回攻員

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

授權

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

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

`appendRange(textRange, matchSourceFormatting)`

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

如果設為與目的地文字的格式相符，系統會將所提供文字範圍內的 AutoText 取代為其算繪值。此外，系統不會附加所提供文字範圍內的任何非文字元素。

參數

名稱	類型	說明
`textRange`	`TextRange`	要附加的文字範圍。
`matchSourceFormatting`	`Boolean`	如果是 `true`，請比照來源文字的格式；如果是 `false`，請比照目的地文字的格式。

回攻員

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

授權

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

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

`appendText(text)`

在文字範圍結尾附加文字。文字會保留現有文字結尾的樣式。

參數

名稱	類型	說明
`text`	`String`	要附加的字串。

回攻員

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

傳回這個範圍所屬形狀或表格儲存格的原始文字。

自動系統會將範圍內的文字元素 (例如產生的投影片編號) 和任何非文字元素，替換為 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)`

清除範圍內由開始和結束偏移量所界定的文字。

由於文字必須以換行符結尾，即使文字的最後一個換行符位於指定偏移量範圍內，也不會遭到移除。

參數

名稱	類型	說明
`startOffset`	`Integer`	目前文字範圍的起始索引之後的字元數，用於判斷要清除的範圍的含頭起始索引。起始位移必須大於或等於 0，且小於或等於 `endOffset`。`startOffset` 也必須小於目前範圍的長度。
`endOffset`	`Integer`	目前文字範圍的起始索引後方字元數，用於判斷要清除的範圍的專屬結束索引。`endOffset` 必須大於或等於 `startOffset`。`endOffset` 也必須小於或等於目前範圍的長度。

授權

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

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

`find(pattern)`

傳回目前文字範圍中與搜尋模式相符的所有範圍。搜尋字詞會區分大小寫。

參數

名稱	類型	說明
`pattern`	`String`	要搜尋的規則運算式模式；模式中的任何反斜線都應逸出。

回攻員

TextRange[]：文字範圍清單。

授權

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

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

`find(pattern, startOffset)`

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

參數

名稱	類型	說明
`pattern`	`String`	要搜尋的規則運算式模式；模式中的任何反斜線都應逸出。
`startOffset`	`Integer`	目前文字範圍的起始索引後方字元數，用於判斷要搜尋範圍的含頭起始索引。`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

`getLinks()`

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

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

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

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

參數

名稱	類型	說明
`startOffset`	`Integer`	目前文字範圍的起始索引後方字元數，用於判斷傳回範圍的含頭起始索引。起始位移必須大於或等於 0，且小於或等於 `endOffset`。`startOffset` 也必須小於目前範圍的長度。
`endOffset`	`Integer`	目前文字範圍的起始索引後方字元數，用於判斷傳回範圍的專屬結束索引。`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)`

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

只要在提供的文字字串中加入至少一個周圍換行字元，系統就會將該字串插入為段落。

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

參數

名稱	類型	說明
`startOffset`	`Integer`	目前文字範圍的起始索引後方字元數，用於判斷要插入文字的含頭起始索引。
`text`	`String`	要插入的字串。

回攻員

Paragraph - 插入的 Paragraph。

授權

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

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

`insertRange(startOffset, textRange)`

在起始偏移處插入所提供文字範圍的副本。

插入文字的格式與來源文字的格式相符。

參數

名稱	類型	說明
`startOffset`	`Integer`	目前文字範圍的起始索引後方字元數，用於判斷要插入文字的含頭起始索引。
`textRange`	`TextRange`	要插入的文字範圍。

回攻員

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

授權

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

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

`insertRange(startOffset, textRange, matchSourceFormatting)`

在起始偏移處插入所提供文字範圍的副本。

如果設為與目的地文字的格式相符，系統會將所提供文字範圍內的 AutoText 取代為其算繪值。此外，系統不會插入所提供文字範圍內的任何非文字元素。

參數

名稱	類型	說明
`startOffset`	`Integer`	目前文字範圍的起始索引後方字元數，用於判斷要插入文字的含頭起始索引。
`textRange`	`TextRange`	要插入的文字範圍。
`matchSourceFormatting`	`Boolean`	如果是 `true`，請比照來源文字的格式；如果是 `false`，請比照目的地文字的格式。

回攻員

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

授權

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

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

`insertText(startOffset, text)`

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

參數

名稱	類型	說明
`startOffset`	`Integer`	目前文字範圍的起始索引後方字元數，用於判斷要插入文字的含頭起始索引。
`text`	`String`	要插入的字串。

回攻員

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

授權

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

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

`isEmpty()`

如果這個範圍沒有任何字元，則傳回 true；否則傳回 false。

回攻員

Boolean - true (如果這個範圍沒有任何字元)，否則會傳回 false。

授權

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

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

`replaceAllText(findText, replaceText)`

將所有符合「尋找文字」的文字例項替換為「取代文字」。搜尋時不區分大小寫。

參數

名稱	類型	說明
`findText`	`String`	要尋找的文字。
`replaceText`	`String`	要用來取代相符文字的文字。

回攻員

Integer - 發生次數已變更

授權

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

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

`replaceAllText(findText, replaceText, matchCase)`

將所有符合「尋找文字」的文字例項取代為「取代文字」。

參數

名稱	類型	說明
`findText`	`String`	要尋找的文字。
`replaceText`	`String`	要用來取代相符文字的文字。
`matchCase`	`Boolean`	如果顯示 `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 將游標放在所需索引。

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

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

參數

名稱	類型	說明
`newText`	`String`	要設為新文字的字串。

回攻員

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

授權

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

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

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

方法

內容詳盡的說明文件

appendParagraph(text)

參數

回攻員

授權

appendRange(textRange)

參數

回攻員

授權

appendRange(textRange, matchSourceFormatting)

參數

回攻員

授權

appendText(text)

參數

回攻員

授權

asRenderedString()

回攻員

授權

asString()

回攻員

授權

clear()

授權

clear(startOffset, endOffset)

參數

授權

find(pattern)

參數

回攻員

授權

find(pattern, startOffset)

參數

回攻員

授權

getAutoTexts()

回攻員

授權

getEndIndex()

回攻員

授權

getLength()

回攻員

授權

getLinks()

回攻員

授權

getListParagraphs()

回攻員

授權

getListStyle()

回攻員

授權

getParagraphStyle()

回攻員

授權

getParagraphs()

回攻員

授權

getRange(startOffset, endOffset)

參數

回攻員

授權

getRuns()

回攻員

授權

getStartIndex()

回攻員

授權

getTextStyle()

回攻員

授權

insertParagraph(startOffset, text)

參數

回攻員

授權

insertRange(startOffset, textRange)

Class TextRange

`appendParagraph(text)`

`appendRange(textRange)`

`appendRange(textRange, matchSourceFormatting)`

`appendText(text)`

`asRenderedString()`

`asString()`

`clear()`

`clear(startOffset, endOffset)`

`find(pattern)`

`find(pattern, startOffset)`

`getAutoTexts()`

`getEndIndex()`

`getLength()`

`getLinks()`

`getListParagraphs()`

`getListStyle()`

`getParagraphStyle()`

`getParagraphs()`

`getRange(startOffset, endOffset)`

`getRuns()`

`getStartIndex()`

`getTextStyle()`

`insertParagraph(startOffset, text)`

`insertRange(startOffset, textRange)`

`insertRange(startOffset, textRange, matchSourceFormatting)`

`insertText(startOffset, text)`

`isEmpty()`

`replaceAllText(findText, replaceText)`

`replaceAllText(findText, replaceText, matchCase)`

`select()`

`setText(newText)`