Visual Basic (Declaration) | |
---|---|
Public Overloads Function Search( _ ByVal sheetIndex 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 reverseSearching As Boolean, _ ByVal startRowIndex As Integer, _ ByVal startColumnIndex As Integer, _ ByVal endRowIndex As Integer, _ ByVal endColumnIndex As Integer, _ ByVal searchAsBlockRange As Boolean, _ ByRef foundRowIndex As Integer, _ ByRef foundColumnIndex As Integer _ ) As SearchFoundFlags |
Visual Basic (Usage) | Copy Code |
---|---|
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) |
C# | |
---|---|
public SearchFoundFlags Search( int sheetIndex, string searchString, bool caseSensitive, bool exactMatch, bool alternateSearch, bool useWildcards, bool includeCellText, bool includeNotes, bool includeTags, bool reverseSearching, int startRowIndex, int startColumnIndex, int endRowIndex, int endColumnIndex, bool searchAsBlockRange, ref int foundRowIndex, 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
The searchAsBlockRange will limit the search to the range as if it is a block of cells. If the search starts with row 0, column 1 and ends at row 3, column 3 then column 0 would not be searched and columns after 3 would not be searched. With searchAsBlockRange set to true, the default search will go from left to right first and then top to bottom. An alternate search would go from top to bottom and then left to right.
If searchAsBlockRange is false then the search will include all cells in the sheet after the specified cell (including cells not in the range).
There are two cases where the searchAsBlockRange parameter is useful:
case 1: alternateSearch = false, searchAsBlockRange is only used when endColumnIndex < startColumnIndex (invalid):
- searchAsBlockRange = true: nothing is adjusted and returns an error value (invalid range)
- searchAsBlockRange = false: range is adjusted as follows:
startColumnIndex = 0
startRowIndex++
case 2: alternateSearch = true, searchAsBlockRange is only used when endRowIndex < startRowIndex (invalid):
- searchAsBlockRange = true: nothing is adjusted and returns an error value (invalid range)
- searchAsBlockRange = false: range is adjusted as follows:
startRowIndex = 0
startColumnIndex++
Target Platforms: Windows 2000 Professional (SP4), Windows 2000 Server, Windows 2003 Server (SP1), Windows 2008, Windows XP (SP2), Windows Vista, Windows 7, Windows 8