Search(String,SearchFlags,SearchOrder,SearchFoundFlags,Int32,Int32) Method

Searches the text in the cells for the specified string with the specified criteria and whether to search notes and tags as well.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Function Search( _
   ByVal searchString As String, _
   ByVal searchFlags As SearchFlags, _
   ByVal searchOrder As SearchOrder, _
   ByVal searchTarget As SearchFoundFlags, _
   ByRef foundRowIndex As Integer, _
   ByRef foundColumnIndex As Integer _
) As SearchFoundFlags

'Usage
 
Dim instance As Worksheet
Dim searchString As String
Dim searchFlags As SearchFlags
Dim searchOrder As SearchOrder
Dim searchTarget As SearchFoundFlags
Dim foundRowIndex As Integer
Dim foundColumnIndex As Integer
Dim value As SearchFoundFlags
 
value = instance.Search(searchString, searchFlags, searchOrder, searchTarget, foundRowIndex, foundColumnIndex)

public SearchFoundFlags Search( 
   string searchString,
   SearchFlags searchFlags,
   SearchOrder searchOrder,
   SearchFoundFlags searchTarget,
   out int foundRowIndex,
   out int foundColumnIndex
)

Parameters

searchString: The string for which to search.
searchFlags: The SearchFlags enumeration that specifies the search options.
searchOrder: The SearchOrder enumeration that specifies whether the search goes by column, row coordinates or row, column coordinates.
searchTarget: The SearchFoundFlags enumeration that indicates whether the search includes the content in the cell notes, tags, or text.
foundRowIndex: The row index at which the match is found.
foundColumnIndex: The column index at which the match is found.

Return Value

A SearchFoundFlags enumeration that specifies what is matched.

Example

This example uses the Search method.

C#
VB.NET

gcSpreadSheet1.Sheets[0].Cells[5, 4].Text = "test";

        private void button1_Click(object sender, RoutedEventArgs e)
        {
            int colfound;
            int rowfound;
            string foundstring;
            colfound = 0;
            rowfound = 0;            
            gcSpreadSheet1.Sheets[0].Search("test", out rowfound, out colfound);
            //gcSpreadSheet1.Sheets[0].Search("test", GrapeCity.Xaml.SpreadSheet.Data.SearchFlags.ExactMatch, out rowfound, out colfound);
            //gcSpreadSheet1.Sheets[0].Search("test", GrapeCity.Xaml.SpreadSheet.Data.SearchFlags.ExactMatch, GrapeCity.Xaml.SpreadSheet.Data.SearchOrder.ZOrder, out rowfound, out colfound);
            //gcSpreadSheet1.Sheets[0].Search("test", GrapeCity.Xaml.SpreadSheet.Data.SearchFlags.ExactMatch, GrapeCity.Xaml.SpreadSheet.Data.SearchOrder.ZOrder, GrapeCity.Xaml.SpreadSheet.Data.SearchFoundFlags.CellText, out rowfound, out colfound);
            //gcSpreadSheet1.Sheets[0].Search("test", GrapeCity.Xaml.SpreadSheet.Data.SearchFlags.ExactMatch, GrapeCity.Xaml.SpreadSheet.Data.SearchOrder.ZOrder, GrapeCity.Xaml.SpreadSheet.Data.SearchFoundFlags.CellText, GrapeCity.Xaml.SpreadSheet.Data.SheetArea.Cells, out rowfound, out colfound);
            //gcSpreadSheet1.Sheets[0].Search("test", GrapeCity.Xaml.SpreadSheet.Data.SearchFlags.ExactMatch, GrapeCity.Xaml.SpreadSheet.Data.SearchOrder.ZOrder, GrapeCity.Xaml.SpreadSheet.Data.SearchFoundFlags.CellText, GrapeCity.Xaml.SpreadSheet.Data.SheetArea.Cells, 0, 0, out rowfound, out colfound);
            //gcSpreadSheet1.Sheets[0].Search("test", GrapeCity.Xaml.SpreadSheet.Data.SearchFlags.ExactMatch, GrapeCity.Xaml.SpreadSheet.Data.SearchOrder.ZOrder, GrapeCity.Xaml.SpreadSheet.Data.SearchFoundFlags.CellText, GrapeCity.Xaml.SpreadSheet.Data.SheetArea.Cells, 0, 0, 7, 7, out rowfound, out colfound);
            //gcSpreadSheet1.Sheets[0].Search("test", GrapeCity.Xaml.SpreadSheet.Data.SearchFlags.ExactMatch, GrapeCity.Xaml.SpreadSheet.Data.SearchOrder.ZOrder, GrapeCity.Xaml.SpreadSheet.Data.SearchFoundFlags.CellText, GrapeCity.Xaml.SpreadSheet.Data.SheetArea.Cells, 0, 0, 7, 7, out rowfound, out colfound);
            //gcSpreadSheet1.Sheets[0].Search("test", GrapeCity.Xaml.SpreadSheet.Data.SearchFlags.ExactMatch, GrapeCity.Xaml.SpreadSheet.Data.SearchOrder.ZOrder, GrapeCity.Xaml.SpreadSheet.Data.SearchFoundFlags.CellText, GrapeCity.Xaml.SpreadSheet.Data.SheetArea.Cells, 0, 0, 7, 7, out rowfound, out colfound, out foundstring);
            listBox1.Items.Add(colfound.ToString());            
            gcSpreadSheet1.Invalidate();
        }

GcSpreadSheet1.Sheets(0).Cells(5, 4).Text = "test"

Private Sub Button_Click_1(sender As Object, e As RoutedEventArgs)
        Dim colfound As Integer
        Dim rowfound As Integer
        Dim sheetfound As Integer
        Dim foundstring As String
        colfound = 0
        rowfound = 0
        sheetfound = 0
        foundstring = ""
        gcSpreadSheet1.SheetCount = 2
        gcSpreadSheet1.Sheets(0).Search("test", rowfound, colfound)
        'GcSpreadSheet1.Sheets(0).Search("test", GrapeCity.Xaml.SpreadSheet.Data.SearchFlags.ExactMatch, rowfound, colfound)
        'GcSpreadSheet1.Sheets(0).Search("test", GrapeCity.Xaml.SpreadSheet.Data.SearchFlags.ExactMatch, GrapeCity.Xaml.SpreadSheet.Data.SearchOrder.ZOrder, rowfound, colfound)
        'GcSpreadSheet1.Sheets(0).Search("test", GrapeCity.Xaml.SpreadSheet.Data.SearchFlags.ExactMatch, GrapeCity.Xaml.SpreadSheet.Data.SearchOrder.ZOrder, GrapeCity.Xaml.SpreadSheet.Data.SearchFoundFlags.CellText, rowfound, colfound)
        'GcSpreadSheet1.Sheets(0).Search("test", GrapeCity.Xaml.SpreadSheet.Data.SearchFlags.ExactMatch, GrapeCity.Xaml.SpreadSheet.Data.SearchOrder.ZOrder, GrapeCity.Xaml.SpreadSheet.Data.SearchFoundFlags.CellText, GrapeCity.Xaml.SpreadSheet.Data.SheetArea.Cells, rowfound, colfound)
        'GcSpreadSheet1.Sheets(0).Search("test", GrapeCity.Xaml.SpreadSheet.Data.SearchFlags.ExactMatch, GrapeCity.Xaml.SpreadSheet.Data.SearchOrder.ZOrder, GrapeCity.Xaml.SpreadSheet.Data.SearchFoundFlags.CellText, GrapeCity.Xaml.SpreadSheet.Data.SheetArea.Cells, 0, 0, rowfound, colfound)
        'GcSpreadSheet1.Sheets(0).Search("test", GrapeCity.Xaml.SpreadSheet.Data.SearchFlags.ExactMatch, GrapeCity.Xaml.SpreadSheet.Data.SearchOrder.ZOrder, GrapeCity.Xaml.SpreadSheet.Data.SearchFoundFlags.CellText, GrapeCity.Xaml.SpreadSheet.Data.SheetArea.Cells, 0, 0, 7, 7, rowfound, colfound)
        'GcSpreadSheet1.Sheets(0).Search("test", GrapeCity.Xaml.SpreadSheet.Data.SearchFlags.ExactMatch, GrapeCity.Xaml.SpreadSheet.Data.SearchOrder.ZOrder, GrapeCity.Xaml.SpreadSheet.Data.SearchFoundFlags.CellText, GrapeCity.Xaml.SpreadSheet.Data.SheetArea.Cells, 0, 0, 7, 7, rowfound, colfound)
        'GcSpreadSheet1.Sheets(0).Search("test", GrapeCity.Xaml.SpreadSheet.Data.SearchFlags.ExactMatch, GrapeCity.Xaml.SpreadSheet.Data.SearchOrder.ZOrder, GrapeCity.Xaml.SpreadSheet.Data.SearchFoundFlags.CellText, GrapeCity.Xaml.SpreadSheet.Data.SheetArea.Cells, 0, 0, 7, 7, rowfound, colfound, foundstring)
        ListBox1.Items.Add(colfound.ToString())
    End Sub

Reference

Worksheet Class
Worksheet Members
Overload List