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

Class TextFinder

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

方法

方法	傳回類型	簡短說明
`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，請將搜尋設為在比對時忽略變音符號，否則比對結果會與變音符號相符。帶有變音符號的符號 (例如重音符號或細胞) 表示該字母的發音與同一字母沒有標示或沒有不同標示時，兩者的發音不同。

參數

名稱	類型	說明
`ignoreDiacritics`	`Boolean`	搜尋是否包含變音符號。

回攻員

TextFinder — 這個文字尋找工具，用於鏈結。

授權

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

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

`matchCase(matchCase)`

如果設為 true，系統會將搜尋設為與搜尋文字的大小寫完全相符，否則搜尋會預設為不區分大小寫。

參數

名稱	類型	說明
`matchCase`	`Boolean`	比對是否區分大小寫。

回攻員

TextFinder — 這個文字尋找工具，用於鏈結。

授權

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

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

`matchEntireCell(matchEntireCell)`

如果設為 true，系統會將搜尋設為比對儲存格的所有內容，否則系統會將搜尋預設為部分相符。

參數

名稱	類型	說明
`matchEntireCell`	`Boolean`	是否整個儲存格相符。

回攻員

TextFinder — 這個文字尋找工具，用於鏈結。

授權

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

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

`matchFormulaText(matchFormulaText)`

如果為 true，會將搜尋設為傳回公式文字中的相符項目，否則，系統會根據顯示的值，考慮含有公式的儲存格。

參數

名稱	類型	說明
`matchFormulaText`	`Boolean`	搜尋是否檢查公式文字。

回攻員

TextFinder — 這個文字尋找工具，用於鏈結。

授權

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

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

`replaceAllWith(replaceText)`

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

參數

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

回攻員

Integer：取代的出現次數。

授權

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

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

`replaceWith(replaceText)`

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

參數

名稱	類型	說明
`replaceText`	`String`	取代目前相符儲存格內容的文字。

回攻員

Integer：取代的出現次數。

授權

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

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

`startFrom(startRange)`

將搜尋設為在指定儲存格範圍後立即開始搜尋。

參數

名稱	類型	說明
`startRange`	`Range`	搜尋開始的儲存格範圍。

回攻員

TextFinder — 這個文字尋找工具，用於鏈結。

授權

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

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

`useRegularExpression(useRegEx)`

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

參數

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

回攻員

TextFinder — 這個文字尋找工具，用於鏈結。

授權

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

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