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

Searches the text in the cells in the specified sheet 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 sheetIndex As System.Integer, _
   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 GcSpreadSheet
Dim sheetIndex As System.Integer
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(sheetIndex, searchString, searchFlags, searchOrder, searchTarget, sheetArea, rowStart, columnStart, rowEnd, columnEnd, foundRowIndex, foundColumnIndex)

public SearchFoundFlags Search( 
   System.int sheetIndex,
   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

sheetIndex: The index of the sheet on which to search.
searchString: The string for which to search.
searchFlags: The GrapeCity.Windows.SpreadSheet.Data.SearchFlags enumeration that specifies the search options.
searchOrder: The GrapeCity.Windows.SpreadSheet.Data.SearchFlags enumeration that specifies whether the search goes by column, row coordinates or row, column coordinates.
searchTarget: The GrapeCity.Windows.SpreadSheet.Data.SearchFoundFlags enumeration that indicates whether the search includes the content in the cell notes, tags, or text.
sheetArea: The area of the sheet to search.
rowStart: The index of the row at which to start.
columnStart: The index of the column at which to start.
rowEnd: The index of the row at which to stop searching.
columnEnd: The index of the column at which to stop searching.
foundRowIndex: The index of the row at which a match is found.
foundColumnIndex: The index of the column at which a match is found.

Return Value

Returns the found flags.

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;
int sheetfound;
string foundstring;
colfound = 0;
rowfound = 0;
sheetfound = 0;
gcSpreadSheet1.SheetCount = 2;
//gcSpreadSheet1.Search(0, "test", out rowfound, out colfound);
//gcSpreadSheet1.Search(0, "test", GrapeCity.Windows.SpreadSheet.Data.SearchFlags.ExactMatch, out rowfound, out colfound);
//gcSpreadSheet1.Search(0, "test", GrapeCity.Windows.SpreadSheet.Data.SearchFlags.ExactMatch, GrapeCity.Windows.SpreadSheet.Data.SearchOrder.ZOrder, out rowfound, out colfound);
//gcSpreadSheet1.Search(0, "test", GrapeCity.Windows.SpreadSheet.Data.SearchFlags.ExactMatch, GrapeCity.Windows.SpreadSheet.Data.SearchOrder.ZOrder, GrapeCity.Windows.SpreadSheet.Data.SearchFoundFlags.CellText, out rowfound, out colfound);
//gcSpreadSheet1.Search(0, "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.Search(0, "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.Search(0, "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.Search(0, 1, "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 sheetfound, out rowfound, out colfound);
gcSpreadSheet1.Search(0, 0, "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 sheetfound, 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.Search(0, "test", rowfound, colfound)
'GcSpreadSheet1.Search(0, "test", GrapeCity.Windows.SpreadSheet.Data.SearchFlags.ExactMatch, rowfound, colfound)
'GcSpreadSheet1.Search(0, "test", GrapeCity.Windows.SpreadSheet.Data.SearchFlags.ExactMatch, GrapeCity.Windows.SpreadSheet.Data.SearchOrder.ZOrder, rowfound, colfound)
'GcSpreadSheet1.Search(0, "test", GrapeCity.Windows.SpreadSheet.Data.SearchFlags.ExactMatch, GrapeCity.Windows.SpreadSheet.Data.SearchOrder.ZOrder, GrapeCity.Windows.SpreadSheet.Data.SearchFoundFlags.CellText, rowfound, colfound)
'GcSpreadSheet1.Search(0, "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.Search(0, "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.Search(0, "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.Search(0, 1, "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, sheetfound, rowfound, colfound)
GcSpreadSheet1.Search(0, 0, "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, sheetfound, rowfound, colfound, foundstring)
ListBox1.Items.Add(colfound.ToString())
GcSpreadSheet1.Invalidate()
    End Sub

Reference

GcSpreadSheet Class
GcSpreadSheet Members
Overload List