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

Worksheet.Search(String) Method

Performs a search in the worksheet using the default parameters.

Namespace: DevExpress.Spreadsheet

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

Declaration

IEnumerable<Cell> Search(
    string text
)
Function Search(
    text As String
) As IEnumerable(Of Cell)
IEnumerable<Cell> Search(
    string text
)
Function Search(
    text As String
) As IEnumerable(Of Cell)
IEnumerable<Cell> Search(
    string text
)
Function Search(
    text As String
) As IEnumerable(Of Cell)

Parameters

Name Type Description
text String

A String representing the search text.

Parameters

Name Type Description
text String

A String representing the search text.

Parameters

Name Type Description
text String

A String representing the search text.

Returns

Type Description
IEnumerable<Cell>

An object implementing the IEnumerable interface which is the collection of cells that match the search term.

Returns

Type Description
IEnumerable<Cell>

An object implementing the IEnumerable interface which is the collection of cells that match the search term.

Returns

Type Description
IEnumerable<Cell>

An object implementing the IEnumerable interface which is the collection of cells that match the search term.

Remarks

Use the Search method to perform a search in the current worksheet with the default parameters listed in the table below.

Option Default Value
Look In Values and Formulas
Search Direction By Rows
Match Case False
Match Entire Cell Contents False

To perform a search in the specific cell range or the entire document, use the CellRange.Search or IWorkbook.Search method. For more information about the search functionality in the SpreadsheetControl, refer to the Find and Replace article.

Examples

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

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

' Find and highlight cells containing the word "holiday".
Dim searchResult As IEnumerable(Of Cell) = worksheet.Search("holiday")
For Each cell As Cell In searchResult
    cell.Fill.BackgroundColor = Color.LightGreen
Next cell
See Also