GrapeCity.Xaml.SpreadSheet.Data
Search(Int32,Int32,String,SearchFlags,SearchOrder,SearchFoundFlags,SheetArea,Int32,Int32,Int32,Int32,Int32,Int32,Int32) Method


GrapeCity.Xaml.SpreadSheet.Data Namespace > Workbook Class > Search Method : Search(Int32,Int32,String,SearchFlags,SearchOrder,SearchFoundFlags,SheetArea,Int32,Int32,Int32,Int32,Int32,Int32,Int32) Method
Index of the sheet on which to start the search.
Index of the sheet on which to end the search.
The string for which to search.
The SearchFlags enumeration that specifies the options of the search.
The SearchFlags enumeration that specifies whether the search goes by column, row coordinates or row, column coordinates.
The SearchFoundFlags enumeration that indicates whether the search includes the content in the cell notes, tags, or text.
The area of the sheet to search.
The index of the row at which to start.
The index of the column at which to start.
The index of the row at which to end.
The index of the column at which to end.
The index of the sheet at which a match is found.
The index of row at which a match is found.
The index of the column at which a match is found.
Searches the text in the cells in the specified sheet for the specified string with the specified criteria and start and end location, and whether to search notes and tags as well.
Syntax
'Declaration
 
Public Overloads Function Search( _
   ByVal startSheetIndex As Integer, _
   ByVal endSheetIndex As Integer, _
   ByVal searchString As String, _
   ByVal searchFlags As SearchFlags, _
   ByVal searchOrder As SearchOrder, _
   ByVal searchTarget As SearchFoundFlags, _
   ByVal sheetArea As SheetArea, _
   ByVal rowStart As Integer, _
   ByVal columnStart As Integer, _
   ByVal rowEnd As Integer, _
   ByVal columnEnd As Integer, _
   ByRef foundSheetIndex As Integer, _
   ByRef foundRowIndex As Integer, _
   ByRef foundColumnIndex As Integer _
) As SearchFoundFlags
'Usage
 
Dim instance As Workbook
Dim startSheetIndex As Integer
Dim endSheetIndex As Integer
Dim searchString As String
Dim searchFlags As SearchFlags
Dim searchOrder As SearchOrder
Dim searchTarget As SearchFoundFlags
Dim sheetArea As SheetArea
Dim rowStart As Integer
Dim columnStart As Integer
Dim rowEnd As Integer
Dim columnEnd As Integer
Dim foundSheetIndex As Integer
Dim foundRowIndex As Integer
Dim foundColumnIndex As Integer
Dim value As SearchFoundFlags
 
value = instance.Search(startSheetIndex, endSheetIndex, searchString, searchFlags, searchOrder, searchTarget, sheetArea, rowStart, columnStart, rowEnd, columnEnd, foundSheetIndex, foundRowIndex, foundColumnIndex)

Parameters

startSheetIndex
Index of the sheet on which to start the search.
endSheetIndex
Index of the sheet on which to end the search.
searchString
The string for which to search.
searchFlags
The SearchFlags enumeration that specifies the options of the search.
searchOrder
The SearchFlags enumeration that specifies whether the search goes by column, row coordinates or row, column coordinates.
searchTarget
The SearchFoundFlags enumeration that indicates whether the search includes the content in the cell notes, tags, or text.
sheetArea
The area of the sheet to search.
rowStart
The index of the row at which to start.
columnStart
The index of the column at which to start.
rowEnd
The index of the row at which to end.
columnEnd
The index of the column at which to end.
foundSheetIndex
The index of the sheet at which a match is found.
foundRowIndex
The index of row at which a match is found.
foundColumnIndex
The index of the column at which a match is found.

Return Value

A SearchFoundFlags enumeration that specifies what is matched.
See Also

Reference

Workbook Class
Workbook Members
Overload List