GSheets Operator > Google Sheets Operator > Find and Replace

Find and Replace

Finds StringToFind and replaces it with ReplacementString in the specified spreadsheet, optionally limiting the operation to a specific sheet and range.

Inputs

In
Exec

In Token
Google Sheets Web Token Object Reference

A validated UGoogleSheetsWebToken object. Used to authenticate the Sheets operation.

Operation Params
Google Sheets Operation Params Structure

Generic request operation parameters

Call on Complete
Delegate (by ref)

This delegate will be called when the operation completes and tell you whether or not it was successful and return the response as a UGoogleSheetsObjectSheet Tab Data Object.

In Spreadsheet Id
String

This is the spreadsheet ID number or key. Get it from your spreadsheet URL by calling GetSpreadsheetIdFromUrl.

Specific Sheet Id
Integer

The ID number or GID of the sheet tab. If blank or negative, this operation will affect the entire spreadsheet on every sheet tab.

Specific Range
String

A single range, expressed in A1 notation, that you wish to retrieve. Call GetRangeInA1NotationFromColumnAndRowIndices passing in 1-based indices.

String to Find
String

A string to find in the specified sheets or range.

Replacement String
String

A string with which to replace instances of StringToFind.

Match Case
Boolean

If true, the search is case sensitive.

Match Entire Cell
Boolean

If true, the find value should match the entire cell.

Search by Regex
Boolean

If true, the find value is a regex. The regular expression and replacement should follow Java regex rules and the replacement string is allowed to refer to capturing groups.

Include Formulas
Boolean

If true, the search should include cells with formulas. False to skip cells with formulas.

Outputs

Out
Exec