Search(Int32,String,Boolean,Boolean,Boolean,Boolean,Boolean,Boolean,Boolean,Boolean,Int32,Int32,Int32,Int32,Boolean,Int32,Int32) Method
In This Topic
Searches the text in the cells in the specified sheet for the specified string with the specified criteria and the location to start and end, and whether to search notes and tags as well.
Syntax
'Declaration
Public Overloads Function Search( _
ByVal As Integer, _
ByVal As String, _
ByVal As Boolean, _
ByVal As Boolean, _
ByVal As Boolean, _
ByVal As Boolean, _
ByVal As Boolean, _
ByVal As Boolean, _
ByVal As Boolean, _
ByVal As Boolean, _
ByVal As Integer, _
ByVal startColumnIndex As Integer, _
ByVal As Integer, _
ByVal endColumnIndex As Integer, _
ByVal As Boolean, _
ByRef As Integer, _
ByRef foundColumnIndex As Integer _
) As SearchFoundFlags
'Usage
Dim instance As FpSpread
Dim sheetIndex 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 reverseSearching As Boolean
Dim startRowIndex As Integer
Dim startColumnIndex As Integer
Dim endRowIndex As Integer
Dim endColumnIndex As Integer
Dim searchAsBlockRange As Boolean
Dim foundRowIndex As Integer
Dim foundColumnIndex As Integer
Dim value As SearchFoundFlags
value = instance.Search(sheetIndex, searchString, caseSensitive, exactMatch, alternateSearch, useWildcards, includeCellText, includeNotes, includeTags, reverseSearching, startRowIndex, startColumnIndex, endRowIndex, endColumnIndex, searchAsBlockRange, foundRowIndex, foundColumnIndex)
public SearchFoundFlags Search(
int ,
string ,
bool ,
bool ,
bool ,
bool ,
bool ,
bool ,
bool ,
bool ,
int ,
int startColumnIndex,
int ,
int endColumnIndex,
bool ,
ref int ,
ref int foundColumnIndex
)
Parameters
- sheetIndex
- Index of sheet on which to 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
- reverseSearching
- Whether the search is in reversed order
- 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
- searchAsBlockRange
- Specifies whether to search the specified block of cells only
- foundRowIndex
- Index of row at which match is found
- foundColumnIndex
- Index of column at which match is found
See Also