FarPoint.Win.Spread Assembly > FarPoint.Win.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 |
'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
'Usage 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)
public SearchFoundFlags Search( int startSheetIndex, int endSheetIndex, string searchString, bool caseSensitive, bool exactMatch, bool alternateSearch, bool useWildcards, bool includeCellText, bool includeNotes, bool includeTags, int startRowIndex, int startColumnIndex, int endRowIndex, int endColumnIndex, ref int foundSheetIndex, ref int foundRowIndex, ref int foundColumnIndex )
Also, the foundRowIndex and foundColumnIndex return the row index and column index of the cell in which the string is found.
The more recently added search methods return a SearchFoundFlag, and not simply a text string, because the search match might be found in the cell notes or the cell tags. You can search optionally any or all of the data cells, the cell notes, or the cell tags or any combination. It starts at the cell location specified (with startRowIndex and startColumnIndex) and goes to the specified end (endRowIndex and endRowIndex) until the string match is found. In addition, you can specify the starting and ending sheet of a range of sheets to search. Besides returning the cell location the sheet is also returned since multiple sheets can be searched. The start location only applies to the first sheet in the search, after that subsequent sheets are searched from the very top. Similarly the end location only applies to the last sheet in the search. Before that sheet, the search continues to the bottom of previous sheets.
// Form Load fpSpread1.Sheets.Count=2; private void button1_Click(object sender, System.EventArgs e) { int x = 0; int y = 0; int z = 0; FarPoint.Win.Spread.SearchFoundFlags sff; sff = fpSpread1.Search(0, 1, "test", false, false, false, false, true, false, false, 0, 0, 5, 5, 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()); }
' Form Load FpSpread1.Sheets.Count = 2 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.Win.Spread.SearchFoundFlags sff = FpSpread1.Search(0, 1, "test", False, False, False, False, True, False, False, 0, 0, 5, 5, z, x, y) ListBox1.Items.Add(sff.ToString()) ListBox1.Items.Add(x) ListBox1.Items.Add(y) ListBox1.Items.Add(z) End Sub
Target Platforms: Windows 2000 Professional (SP4), Windows 2000 Server, Windows 2003 Server (SP1), Windows Server 2012 R2, Windows 2008, Windows XP (SP2), Windows Vista, Windows 7, Windows 8, Windows 8.1, Windows 10