Spread WPF Documentation
Search(String,SearchFlags,SearchOrder,SearchFoundFlags,Int32,Int32) Method
Example 


GrapeCity.Windows.SpreadSheet.Data Namespace > Worksheet Class > Search Method : Search(String,SearchFlags,SearchOrder,SearchFoundFlags,Int32,Int32) Method
The string for which to search.
The SearchFlags enumeration that specifies the search options.
The SearchOrder enumeration that specifies whether the search goes by column, row coordinates or row, column coordinates.
The SearchFoundFlags enumeration that indicates whether the search includes the content in the cell notes, tags, or text.
The row index at which the match is found.
The column index at which the match is found.
Searches the text in the cells for the specified string with the specified criteria and whether to search notes and tags as well.
Syntax
'Declaration
 
Public Overloads Function Search( _
   ByVal searchString As System.String, _
   ByVal searchFlags As SearchFlags, _
   ByVal searchOrder As SearchOrder, _
   ByVal searchTarget As SearchFoundFlags, _
   ByRef foundRowIndex As System.Integer, _
   ByRef foundColumnIndex As System.Integer _
) As SearchFoundFlags
'Usage
 
Dim instance As Worksheet
Dim searchString As System.String
Dim searchFlags As SearchFlags
Dim searchOrder As SearchOrder
Dim searchTarget As SearchFoundFlags
Dim foundRowIndex As System.Integer
Dim foundColumnIndex As System.Integer
Dim value As SearchFoundFlags
 
value = instance.Search(searchString, searchFlags, searchOrder, searchTarget, foundRowIndex, foundColumnIndex)
public SearchFoundFlags Search( 
   System.string searchString,
   SearchFlags searchFlags,
   SearchOrder searchOrder,
   SearchFoundFlags searchTarget,
   out System.int foundRowIndex,
   out System.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.
private void Window_Loaded(object sender, RoutedEventArgs e)
        {
gcSpreadSheet1.Sheets[0].Cells[5, 4].Text = "test";
gcSpreadSheet1.Invalidate();                
        }

        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.Windows.SpreadSheet.Data.SearchFlags.ExactMatch, out rowfound, out colfound);
            //gcSpreadSheet1.Sheets[0].Search("test", GrapeCity.Windows.SpreadSheet.Data.SearchFlags.ExactMatch, GrapeCity.Windows.SpreadSheet.Data.SearchOrder.ZOrder, out rowfound, out colfound);
            //gcSpreadSheet1.Sheets[0].Search("test", GrapeCity.Windows.SpreadSheet.Data.SearchFlags.ExactMatch, GrapeCity.Windows.SpreadSheet.Data.SearchOrder.ZOrder, GrapeCity.Windows.SpreadSheet.Data.SearchFoundFlags.CellText, out rowfound, out colfound);
            //gcSpreadSheet1.Sheets[0].Search("test", GrapeCity.Windows.SpreadSheet.Data.SearchFlags.ExactMatch, GrapeCity.Windows.SpreadSheet.Data.SearchOrder.ZOrder, GrapeCity.Windows.SpreadSheet.Data.SearchFoundFlags.CellText, GrapeCity.Windows.SpreadSheet.Data.SheetArea.Cells, out rowfound, out colfound);
            //gcSpreadSheet1.Sheets[0].Search("test", GrapeCity.Windows.SpreadSheet.Data.SearchFlags.ExactMatch, GrapeCity.Windows.SpreadSheet.Data.SearchOrder.ZOrder, GrapeCity.Windows.SpreadSheet.Data.SearchFoundFlags.CellText, GrapeCity.Windows.SpreadSheet.Data.SheetArea.Cells, 0, 0, out rowfound, out colfound);
            //gcSpreadSheet1.Sheets[0].Search("test", GrapeCity.Windows.SpreadSheet.Data.SearchFlags.ExactMatch, GrapeCity.Windows.SpreadSheet.Data.SearchOrder.ZOrder, GrapeCity.Windows.SpreadSheet.Data.SearchFoundFlags.CellText, GrapeCity.Windows.SpreadSheet.Data.SheetArea.Cells, 0, 0, 7, 7, out rowfound, out colfound);
            //gcSpreadSheet1.Sheets[0].Search("test", GrapeCity.Windows.SpreadSheet.Data.SearchFlags.ExactMatch, GrapeCity.Windows.SpreadSheet.Data.SearchOrder.ZOrder, GrapeCity.Windows.SpreadSheet.Data.SearchFoundFlags.CellText, GrapeCity.Windows.SpreadSheet.Data.SheetArea.Cells, 0, 0, 7, 7, out rowfound, out colfound);
            //gcSpreadSheet1.Sheets[0].Search("test", GrapeCity.Windows.SpreadSheet.Data.SearchFlags.ExactMatch, GrapeCity.Windows.SpreadSheet.Data.SearchOrder.ZOrder, GrapeCity.Windows.SpreadSheet.Data.SearchFoundFlags.CellText, GrapeCity.Windows.SpreadSheet.Data.SheetArea.Cells, 0, 0, 7, 7, out rowfound, out colfound, out foundstring);
            listBox1.Items.Add(colfound.ToString());            
            gcSpreadSheet1.Invalidate();
        }
Private Sub Window_Loaded(sender As System.Object, e As System.Windows.RoutedEventArgs) Handles MyBase.Loaded
GcSpreadSheet1.Sheets(0).Cells(5, 4).Text = "test"
GcSpreadSheet1.Invalidate()
End Sub

    Private Sub Button1_Click(sender As System.Object, e As System.Windows.RoutedEventArgs) Handles Button1.Click
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.Windows.SpreadSheet.Data.SearchFlags.ExactMatch, rowfound, colfound)
'GcSpreadSheet1.Sheets(0).Search("test", GrapeCity.Windows.SpreadSheet.Data.SearchFlags.ExactMatch, GrapeCity.Windows.SpreadSheet.Data.SearchOrder.ZOrder, rowfound, colfound)
'GcSpreadSheet1.Sheets(0).Search("test", GrapeCity.Windows.SpreadSheet.Data.SearchFlags.ExactMatch, GrapeCity.Windows.SpreadSheet.Data.SearchOrder.ZOrder, GrapeCity.Windows.SpreadSheet.Data.SearchFoundFlags.CellText, rowfound, colfound)
'GcSpreadSheet1.Sheets(0).Search("test", GrapeCity.Windows.SpreadSheet.Data.SearchFlags.ExactMatch, GrapeCity.Windows.SpreadSheet.Data.SearchOrder.ZOrder, GrapeCity.Windows.SpreadSheet.Data.SearchFoundFlags.CellText, GrapeCity.Windows.SpreadSheet.Data.SheetArea.Cells, rowfound, colfound)
'GcSpreadSheet1.Sheets(0).Search("test", GrapeCity.Windows.SpreadSheet.Data.SearchFlags.ExactMatch, GrapeCity.Windows.SpreadSheet.Data.SearchOrder.ZOrder, GrapeCity.Windows.SpreadSheet.Data.SearchFoundFlags.CellText, GrapeCity.Windows.SpreadSheet.Data.SheetArea.Cells, 0, 0, rowfound, colfound)
'GcSpreadSheet1.Sheets(0).Search("test", GrapeCity.Windows.SpreadSheet.Data.SearchFlags.ExactMatch, GrapeCity.Windows.SpreadSheet.Data.SearchOrder.ZOrder, GrapeCity.Windows.SpreadSheet.Data.SearchFoundFlags.CellText, GrapeCity.Windows.SpreadSheet.Data.SheetArea.Cells, 0, 0, 7, 7, rowfound, colfound)
'GcSpreadSheet1.Sheets(0).Search("test", GrapeCity.Windows.SpreadSheet.Data.SearchFlags.ExactMatch, GrapeCity.Windows.SpreadSheet.Data.SearchOrder.ZOrder, GrapeCity.Windows.SpreadSheet.Data.SearchFoundFlags.CellText, GrapeCity.Windows.SpreadSheet.Data.SheetArea.Cells, 0, 0, 7, 7, rowfound, colfound)
'GcSpreadSheet1.Sheets(0).Search("test", GrapeCity.Windows.SpreadSheet.Data.SearchFlags.ExactMatch, GrapeCity.Windows.SpreadSheet.Data.SearchOrder.ZOrder, GrapeCity.Windows.SpreadSheet.Data.SearchFoundFlags.CellText, GrapeCity.Windows.SpreadSheet.Data.SheetArea.Cells, 0, 0, 7, 7, rowfound, colfound, foundstring)
ListBox1.Items.Add(colfound.ToString())
GcSpreadSheet1.Invalidate()
    End Sub
See Also

Reference

Worksheet Class
Worksheet Members
Overload List