FindOptions API in JavaScript (ES5) Spreadsheet API control

Specifies the options for performing a find and replace action in the spreadsheet. These options control how and where the search operation is executed, as well as how to replace values.

Properties

findCount

string

Specifies the count of occurrences of the found value. This is the number of times the search value appears in the sheet or workbook.

findOpt

string

Specifies the option to find the previous or next match of the value.

• “Next”: Finds the next occurrence of the value.
• “Previous”: Finds the previous occurrence of the value.

isAction

boolean

Specifies whether to return the match after the find action.

• true: Returns the matching value after the find operation.
• false: Does not return any match.

isCSen

boolean

Specifies whether to match the case when finding the value.

• true: The search will be case-sensitive.
• false: The search will be case-insensitive.

isEMatch

boolean

Specifies whether to match the entire cell content or a substring of the cell content.

• true: The search will match only the entire content of the cell.
• false: The search will match any part of the cell content (substring search).

mode

string

Specifies whether to search for the value within the current sheet or the entire workbook.

• “Sheet”: Searches only within the current active sheet.
• “Workbook”: Searches across all sheets in the workbook.

replaceBy

string

Specifies whether to replace the first match or all matches of the found value.

• “First”: Replaces only the first found value.
• “All”: Replaces all occurrences of the found value.

replaceValue

string

Specifies the value to replace the found value with. This is used when performing the replace operation.

searchBy

string

Specifies whether to search for the value by row or by column.

• “Row”: Searches row by row (horizontally).
• “Column”: Searches column by column (vertically).

sheetIndex

number

Specifies the index of the sheet to search for the value. This refers to the sheet number (0-based index) where the search should begin.

showDialog

boolean

Specifies whether to display the find and replace dialog.

• true: Displays the find and replace dialog for user interaction.
• false: Does not display the dialog.

value

string

Specifies the value to find in the spreadsheet. This is the text or number that you want to search for within the cells.