Class FindOptions

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

Inheritance
System.Object
FindOptions
ReplaceOptions
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.Windows.Documents.Spreadsheet.Model
Assembly: Telerik.Windows.Documents.Spreadsheet.dll

Syntax

public class FindOptions

Constructors

FindOptions()

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

Declaration
public FindOptions()

Properties

FindBy

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

Declaration
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
public FindInContentType FindIn { get; set; }
Property Value
FindInContentType

The find in option.

FindWhat

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

Declaration
public string FindWhat { get; set; }
Property Value
System.String

The searched string.

FindWithin

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

Declaration
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
public bool MatchCase { get; set; }
Property Value
System.Boolean

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
public bool MatchEntireCellContents { get; set; }
Property Value
System.Boolean

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
public IEnumerable<CellRange> SearchRanges { get; set; }
Property Value
System.Collections.Generic.IEnumerable<CellRange>

The search ranges.

StartCell

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

Declaration
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
public void CopyPropertiesFrom(FindOptions options)
Parameters
FindOptions options

The options.

Equals(Object)

Determines whether the specified System.Object is equal to the current System.Object.

Declaration
public override bool Equals(object obj)
Parameters
System.Object obj

The System.Object to compare with the current System.Object.
Returns
System.Boolean

True if the specified System.Object is equal to the current System.Object; otherwise, false.
Overrides
System.Object.Equals(System.Object)

GetHashCode()

Serves as a hash function for a particular type.

Declaration
public override int GetHashCode()
Returns
System.Int32

A hash code for the current System.Object.
Overrides
System.Object.GetHashCode()

Extension Methods