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)

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
)

Parameters

startSheetIndex

Sheet index on which to start the search

endSheetIndex

Sheet index on which to end the 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

Row index at which to start

startColumnIndex

Column index at which to start

endRowIndex

Row index at which to end

endColumnIndex

Column index at which to end

foundSheetIndex

Sheet index at which the match is found

foundRowIndex

Row index at which the match is found

foundColumnIndex

Column index at which the match is found

Return Value

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.

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

Reference