Spread ASP.NET 6.0 Product Documentation
Search(Int32,Int32,String,Boolean,Boolean,Boolean,Boolean,Boolean,Boolean,Boolean,Int32,Int32,Int32,Int32,Int32,Int32,Int32) Method
See Also  Example Send Feedback
FarPoint.Web.Spread Assembly > FarPoint.Web.Spread Namespace > FpSpread Class > Search Method : Search(Int32,Int32,String,Boolean,Boolean,Boolean,Boolean,Boolean,Boolean,Boolean,Int32,Int32,Int32,Int32,Int32,Int32,Int32) Method


startSheetIndex
Index of sheet on which to start search
endSheetIndex
Index of sheet on which to end search
searchString
String for which to search
caseSensitive
Whether the search considers the case of the letters in the search string
exactMatch
Whether the search considers only an exact match
alternateSearch
Whether the search goes by alternate coordinates of column, row (instead of row, column)
useWildcards
Whether the search considers wildcard characters (*, ?) in the search string
includeCellText
Whether the search includes the content in the cell
includeNotes
Whether the search includes the content in the cell notes
includeTags
Whether the search includes the content in the cell tags or their string representations
startRowIndex
Index of row at which to start
startColumnIndex
Index of column at which to start
endRowIndex
Index of row at which to end
endColumnIndex
Index of column at which to end
foundSheetIndex
Index of sheet at which match is found
foundRowIndex
Index of row at which match is found
foundColumnIndex
Index of column at which match is found

Glossary Item Box

Searches the text in the specified range of cells in the specified sheet range for the specified string with the specified criteria.

Syntax

Visual Basic (Declaration) 
Public Overloads Function Search( _
   ByVal startSheetIndex As Integer, _
   ByVal endSheetIndex As Integer, _
   ByVal searchString As String, _
   ByVal caseSensitive As Boolean, _
   ByVal exactMatch As Boolean, _
   ByVal alternateSearch As Boolean, _
   ByVal useWildcards As Boolean, _
   ByVal includeCellText As Boolean, _
   ByVal includeNotes As Boolean, _
   ByVal includeTags As Boolean, _
   ByVal startRowIndex As Integer, _
   ByVal startColumnIndex As Integer, _
   ByVal endRowIndex As Integer, _
   ByVal endColumnIndex As Integer, _
   ByRef foundSheetIndex As Integer, _
   ByRef foundRowIndex As Integer, _
   ByRef foundColumnIndex As Integer _
) As SearchFoundFlags
Visual Basic (Usage)Copy Code
Dim instance As FpSpread
Dim startSheetIndex As Integer
Dim endSheetIndex As Integer
Dim searchString As String
Dim caseSensitive As Boolean
Dim exactMatch As Boolean
Dim alternateSearch As Boolean
Dim useWildcards As Boolean
Dim includeCellText As Boolean
Dim includeNotes As Boolean
Dim includeTags As Boolean
Dim startRowIndex As Integer
Dim startColumnIndex As Integer
Dim endRowIndex As Integer
Dim endColumnIndex As Integer
Dim foundSheetIndex As Integer
Dim foundRowIndex As Integer
Dim foundColumnIndex As Integer
Dim value As SearchFoundFlags
 
value = instance.Search(startSheetIndex, endSheetIndex, searchString, caseSensitive, exactMatch, alternateSearch, useWildcards, includeCellText, includeNotes, includeTags, startRowIndex, startColumnIndex, endRowIndex, endColumnIndex, foundSheetIndex, foundRowIndex, foundColumnIndex)

Parameters

startSheetIndex
Index of sheet on which to start search
endSheetIndex
Index of sheet on which to end search
searchString
String for which to search
caseSensitive
Whether the search considers the case of the letters in the search string
exactMatch
Whether the search considers only an exact match
alternateSearch
Whether the search goes by alternate coordinates of column, row (instead of row, column)
useWildcards
Whether the search considers wildcard characters (*, ?) in the search string
includeCellText
Whether the search includes the content in the cell
includeNotes
Whether the search includes the content in the cell notes
includeTags
Whether the search includes the content in the cell tags or their string representations
startRowIndex
Index of row at which to start
startColumnIndex
Index of column at which to start
endRowIndex
Index of row at which to end
endColumnIndex
Index of column at which to end
foundSheetIndex
Index of sheet at which match is found
foundRowIndex
Index of row at which match is found
foundColumnIndex
Index of column at which match is found

Return Value

SearchFoundFlags setting, that specifies in what type of object the string was found, is returned.

Also, the foundSheetIndex, foundRowIndex, foundColumnIndex parameters return the sheet index, row index, and column index of the cell in which the string is found.

Example

This example uses the Search method.
C#Copy Code
// Page Load
FpSpread1.Sheets.Count = 2;
FpSpread1.Sheets[0].Cells[1, 1].Tag = "test";
private void Button1_Click(object sender, System.EventArgs e)
{ 
int x = 0;
int y = 0;
int z =0;
FarPoint.Web.Spread.SearchFoundFlags sff;
sff = FpSpread1.Search(0, 1, "test", false, false, false, false, false, false, true, 0, 0, 2, 2, ref z, ref x, ref y);
ListBox1.Items.Add(sff.ToString());
ListBox1.Items.Add(x.ToString());
ListBox1.Items.Add(y.ToString());
ListBox1.Items.Add(z.ToString());
}
Visual BasicCopy Code
'Page Load 
FpSpread1.Sheets.Count = 2
FpSpread1.Sheets(0).Cells(1, 1).Tag = "test"

Private Sub Button1_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles Button1.Click
Dim x As Integer
Dim y As Integer
Dim z As Integer
Dim sff As FarPoint.Web.Spread.SearchFoundFlags
sff = FpSpread1.Search(0, 1, "test", False, False, False, False, False, False, True, 0, 0, 2, 2, z, x, y)
ListBox1.Items.Add(sff.ToString())
ListBox1.Items.Add(x)
ListBox1.Items.Add(y)
ListBox1.Items.Add(z)
End Sub

Requirements

Target Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows Server 2008 family

See Also

© 2002-2012 GrapeCity, Inc. All Rights Reserved.