Optional
fieldsAn enum of the types of values to search within each field.
Optional
matchIf true
then the text search is case sensitive.
Optional
matchIf true
the text must match the entire cell to be true.
Optional
useDetermines whether the find operation should treat the search text as a regular expression (RegEx).
When true
, the search text will be interpreted as a regular expression (RegEx), allowing for
advanced pattern matching.
If false
, the find operation will not use RegEx but will support three wildcard characters
for flexible searching:
?
(question mark): Matches any single character.*
(asterisk): Matches any number of characters, including zero.~
(tilde followed by ?
, *
, or ~
): Escapes the wildcard characters (?
or *
) to allow
searching for these literal characters in the text.Example usage:
// Search for text matching a RegEx pattern
const Iterator<ICell> results = range.find("\\d+", { useRegex: true}); // Finds numeric values
// Search for text using wildcards
const Iterator<ICell> results = range.find("abc*", { useRegex: false }); // Finds text starting with "abc"
Options use for filtering elements during a find.