Class TextFinder

文字Finder

尋找或取代指定範圍、工作表或試算表中的文字。也可以指定搜尋選項。

方法

方法傳回類型簡短說明
findAll()Range[]傳回符合搜尋條件的所有儲存格。
findNext()Range傳回符合搜尋條件的下一個儲存格。
findPrevious()Range傳回符合搜尋條件的前一個儲存格。
getCurrentMatch()Range傳回符合搜尋條件的目前儲存格。
ignoreDiacritics(ignoreDiacritics)TextFinder如果為 true，則設定搜尋作業在比對時忽略附加符號；否則搜尋作業會比對附加符號。
matchCase(matchCase)TextFinder如果為 true，則會將搜尋設為完全比對搜尋文字的大小寫，否則搜尋會預設為不區分大小寫的比對方式。
matchEntireCell(matchEntireCell)TextFinder如果為 true，則會將搜尋內容設為比對儲存格中的整個內容；否則，搜尋內容預設為部分比對。
matchFormulaText(matchFormulaText)TextFinder如果為 true，則搜尋結果會傳回公式文字中出現的符合項目；否則，系統會根據顯示值來考量含有公式的儲存格。
replaceAllWith(replaceText)Integer將所有比對相符項目替換為指定的文字。
replaceWith(replaceText)Integer將目前比對的儲存格中的搜尋文字替換為指定的文字，並傳回已取代的出現次數。
startFrom(startRange)TextFinder設定搜尋作業，在指定的儲存格範圍後立即開始搜尋。
useRegularExpression(useRegEx)TextFinder如果為 true，則會將搜尋字串解讀為規則運算式；否則，搜尋會將搜尋字串解讀為一般文字。

內容詳盡的說明文件

findAll()

傳回符合搜尋條件的所有儲存格。

回攻員

Range[]：所有相符的儲存格。

授權

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

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

findNext()

傳回符合搜尋條件的下一個儲存格。

回攻員

Range：下一個相符的儲存格，如果沒有先前的相符項目，則為 null。

授權

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

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

findPrevious()

傳回符合搜尋條件的前一個儲存格。

回攻員

Range：前一個相符的儲存格，如果沒有前一個相符項目，則為 null。

授權

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

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

getCurrentMatch()

傳回符合搜尋條件的目前儲存格。

回攻員

Range：目前相符的儲存格，如果沒有其他相符項目，則為 null。

授權

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

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

ignoreDiacritics(ignoreDiacritics)

如果為 true，則設定搜尋功能在比對時忽略附加符號；否則搜尋會比對附加符號。變音符號是指重音符號或塞迪拉，當這些符號寫在字母上方或下方時，表示與未標記或標記不同的字母發音不同。

參數

名稱類型說明
ignoreDiacriticsBoolean搜尋是否會考慮附加符號。

回攻員

TextFinder：這個文字搜尋器可用於鏈結。

授權

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

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

matchCase(matchCase)

如果為 true，則會將搜尋設為完全比對搜尋文字的大小寫，否則搜尋會預設為不區分大小寫的比對方式。

參數

名稱類型說明
matchCaseBoolean比對時是否區分大小寫。

回攻員

TextFinder：這個文字搜尋器可用於鏈結。

授權

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

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

matchEntireCell(matchEntireCell)

如果為 true，則會將搜尋內容設為比對儲存格中的整個內容；否則，搜尋內容預設為部分比對。

參數

名稱類型說明
matchEntireCellBoolean是否要比對整個儲存格。

回攻員

TextFinder：這個文字搜尋器可用於鏈結。

授權

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

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

matchFormulaText(matchFormulaText)

如果為 true，則搜尋結果會傳回公式文字中出現的符合項目；否則，系統會根據顯示值來考量含有公式的儲存格。

參數

名稱類型說明
matchFormulaTextBoolean搜尋是否會檢查公式文字。

回攻員

TextFinder：這個文字搜尋器可用於鏈結。

授權

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

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

replaceAllWith(replaceText)

將所有比對相符項目替換為指定的文字。傳回已替換的項目數量，可能與相符儲存格的數量不同。

參數

名稱類型說明
replaceTextString取代相符儲存格中的文字。

回攻員

Integer：取代發生次數。

授權

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

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

replaceWith(replaceText)

將目前比對的儲存格中的搜尋文字替換為指定的文字，並傳回已取代的出現次數。

參數

名稱類型說明
replaceTextString取代目前已比對儲存格內容的文字。

回攻員

Integer：取代發生次數。

授權

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

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

startFrom(startRange)

設定搜尋作業，在指定的儲存格範圍後立即開始搜尋。

參數

名稱類型說明
startRangeRange搜尋作業應從這個儲存格範圍開始。

回攻員

TextFinder：這個文字搜尋器可用於鏈結。

授權

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

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

useRegularExpression(useRegEx)

如果為 true，則會將搜尋字串解讀為規則運算式；否則，搜尋會將搜尋字串解讀為一般文字。如要進一步瞭解如何使用規則運算式，請參閱 「尋找及取代」支援頁面。

參數

名稱類型說明
useRegExBoolean是否將搜尋字串解讀為規則運算式。

回攻員

TextFinder：這個文字搜尋器可用於鏈結。

授權

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

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