The requested page is not available for the requested platform. You are viewing the content for .NET Framework 4.5.2+ platform.
.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
.NET Core 3.0+
Row

SearchOptions.SearchBy Property

Gets or sets the direction of the search.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v19.2.Core.dll

Declaration

public SearchBy SearchBy { get; set; }
Public Property SearchBy As SearchBy
public SearchBy SearchBy { get; set; }
Public Property SearchBy As SearchBy
public SearchBy SearchBy { get; set; }
Public Property SearchBy As SearchBy

Property Value

Type Description
SearchBy

One of the SearchBy enumeration values indicating whether to search by rows or by columns.

Property Value

Type Description
SearchBy

One of the SearchBy enumeration values indicating whether to search by rows or by columns.

Property Value

Type Description
SearchBy

One of the SearchBy enumeration values indicating whether to search by rows or by columns.

Remarks

For more information about how to perform a search in the document, see Find and Replace.

Examples

The example below demonstrates how to perform a search with the specified options in the active worksheet and highlight all matching cells.

workbook.LoadDocument("Documents\ExpenseReport.xlsx")
workbook.Calculate()
Dim worksheet As Worksheet = workbook.Worksheets(0)

' Specify the search term.
Dim searchString As String = Date.Today.ToString("d")

' Specify search options.
Dim options As New SearchOptions()
options.SearchBy = SearchBy.Columns
options.SearchIn = SearchIn.Values
options.MatchEntireCellContents = True

' Find all cells containing today's date and paint them light-green.
Dim searchResult As IEnumerable(Of Cell) = worksheet.Search(searchString, options)
For Each cell As Cell In searchResult
    cell.Fill.BackgroundColor = Color.LightGreen
Next cell
See Also