Class
FindOptions

Configuration for find operations specifying search criteria, scope, direction, and matching rules.

Definition

Namespace:Telerik.Windows.Documents.Spreadsheet.Model

Assembly:Telerik.Windows.Documents.Spreadsheet.dll

Syntax:

cs-api-definition
public class FindOptions

Inheritance: objectFindOptions

Derived Classes: ReplaceOptions

Constructors

FindOptions()

Initializes find options with default settings: search by rows within the current sheet in formula content.

Declaration

cs-api-definition
public FindOptions()

Properties

FindBy

Direction for traversing cells, either row-by-row or column-by-column.

Declaration

cs-api-definition
public FindBy FindBy { get; set; }

Property Value

FindBy

The find by option.

FindIn

Cell content type to search within: raw formula text or formatted display values.

Declaration

cs-api-definition
public FindInContentType FindIn { get; set; }

Property Value

FindInContentType

The find in option.

FindWhat

Text pattern to search for; supports wildcards (* and ?) unless escaped.

Declaration

cs-api-definition
public string FindWhat { get; set; }

Property Value

string

The searched string.

FindWithin

Scope controlling whether to search only the current sheet or across the entire workbook.

Declaration

cs-api-definition
public FindWithin FindWithin { get; set; }

Property Value

FindWithin

The find within option.

MatchCase

Whether to perform case-sensitive matching; when false, comparisons ignore case.

Declaration

cs-api-definition
public bool MatchCase { get; set; }

Property Value

bool

The value indicating whether the match case option should be used.

MatchEntireCellContents

Whether to match only when the search pattern equals the entire cell content, not just a substring.

Declaration

cs-api-definition
public bool MatchEntireCellContents { get; set; }

Property Value

bool

The value indicating whether the option to match entire cell contents should be used.

SearchRanges

Optional collection of cell ranges to limit the search scope; if null, searches the entire configured scope.

Declaration

cs-api-definition
public IEnumerable<CellRange> SearchRanges { get; set; }

Property Value

IEnumerable<CellRange>

The search ranges.

StartCell

Cell position where the search begins; subsequent searches wrap around if no match is found.

Declaration

cs-api-definition
public WorksheetCellIndex StartCell { get; set; }

Property Value

WorksheetCellIndex

The start cell.

Methods

CopyPropertiesFrom(FindOptions)

Copies all search configuration properties from another FindOptions instance into this one.

Declaration

cs-api-definition
public void CopyPropertiesFrom(FindOptions options)

Parameters

options

FindOptions

The options.

Equals(object)

Determines whether the specified object is equal to the current object.

Declaration

cs-api-definition
public override bool Equals(object obj)

Parameters

obj

object

The object to compare with the current object.

Returns

bool

True if the specified object is equal to the current object; otherwise, false.

Overrides object.Equals(object)

GetHashCode()

Serves as a hash function for a particular type.

Declaration

cs-api-definition
public override int GetHashCode()

Returns

int

A hash code for the current object.

Overrides object.GetHashCode()