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

Searches the cell text in the specified sheet area for the specified string with the specified criteria and start and end location, and whether to search notes and tags as well.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Function Search( _
   ByVal searchString As System.String, _
   ByVal searchFlags As SearchFlags, _
   ByVal searchOrder As SearchOrder, _
   ByVal searchTarget As SearchFoundFlags, _
   ByVal sheetArea As SheetArea, _
   ByVal rowStart As System.Integer, _
   ByVal columnStart As System.Integer, _
   ByVal rowEnd As System.Integer, _
   ByVal columnEnd As System.Integer, _
   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 sheetArea As SheetArea
Dim rowStart As System.Integer
Dim columnStart As System.Integer
Dim rowEnd As System.Integer
Dim columnEnd As System.Integer
Dim foundRowIndex As System.Integer
Dim foundColumnIndex As System.Integer
Dim value As SearchFoundFlags
 
value = instance.Search(searchString, searchFlags, searchOrder, searchTarget, sheetArea, rowStart, columnStart, rowEnd, columnEnd, foundRowIndex, foundColumnIndex)

public SearchFoundFlags Search( 
   System.string searchString,
   SearchFlags searchFlags,
   SearchOrder searchOrder,
   SearchFoundFlags searchTarget,
   SheetArea sheetArea,
   System.int rowStart,
   System.int columnStart,
   System.int rowEnd,
   System.int columnEnd,
   out System.int foundRowIndex,
   out System.int foundColumnIndex
)

Parameters

searchString: The string for which to search.
searchFlags: The SearchFlags enumeration that specifies the options of the search.
searchOrder: The SearchOrder enumeration that specifies whether the search goes by column then row coordinates or row then column coordinates.
searchTarget: The SearchFoundFlags enumeration that indicates whether the search includes the content in the cell notes, tags, or text.
sheetArea: The sheet area to search.
rowStart: The row index at which to start.
columnStart: The column index at which to start.
rowEnd: The row index at which to end.
columnEnd: The column index at which to end.
foundRowIndex: The row index at which a match is found.
foundColumnIndex: The column index at which a 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();
        }

VB.NET

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

Requirements

Target Platforms: Windows 7, Windows 8 Desktop, Windows Vista SP1 or later, Windows Server 2000, Windows 2000 Professional (SP4), Windows XP (SP2), Windows 2008, Windows 2003 Server (SP1)

Reference

Worksheet Class
Worksheet Members
Overload List