FarPoint.Win.Spread Assembly > FarPoint.Win.Spread Namespace > FpSpread Class > Search Method : Search(Int32,String,Boolean,Boolean,Boolean,Boolean,Boolean,Boolean,Boolean,Boolean,Int32,Int32,Int32,Int32,Int32,Int32) Method |
'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 searchAsBlockRange As Boolean, _ ByVal startRowIndex As Integer, _ ByVal startColumnIndex As Integer, _ ByVal endRowIndex As Integer, _ ByVal endColumnIndex As Integer, _ ByRef foundRowIndex 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 searchAsBlockRange As Boolean Dim startRowIndex As Integer Dim startColumnIndex As Integer Dim endRowIndex As Integer Dim endColumnIndex As Integer Dim foundRowIndex As Integer Dim foundColumnIndex As Integer Dim value As SearchFoundFlags value = instance.Search(sheetIndex, searchString, caseSensitive, exactMatch, alternateSearch, useWildcards, includeCellText, includeNotes, includeTags, searchAsBlockRange, startRowIndex, startColumnIndex, endRowIndex, endColumnIndex, foundRowIndex, foundColumnIndex)
public SearchFoundFlags Search( int sheetIndex, string searchString, bool caseSensitive, bool exactMatch, bool alternateSearch, bool useWildcards, bool includeCellText, bool includeNotes, bool includeTags, bool searchAsBlockRange, int startRowIndex, int startColumnIndex, int endRowIndex, int endColumnIndex, 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 limit the left-most column, right-most column, top-most row, and bottom-most row of the search by specifying a block range.
To do this, you set the searchAsBlockRange to true and then the start and end indexes serve as the defining limits of the search. For example if your start column index is 5, the search never goes to columns less than an index of 5 in any row.If cells are searched, this search method searches all the cells that contain data that can be represented as a string by the Text property of that cell, and that includes hidden and locked cells.
This search method checks the formatted string, that is the Text in the cell, not the Value. If tags are searched, it only searches tags that are String data type.
For a hierarchy of sheets, this method only searches cells in a parent sheet. To search child sheets, you would need to perform a separate search of each child sheet.
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).
int x = 0; int y = 0; FarPoint.Win.Spread.SearchFoundFlags sff; sff = fpSpread1.Search(0, "test", false, false, false, false, true, false, false, true, 0, 1, 3, 3, ref x, ref y); listBox1.Items.Add(sff.ToString()); listBox1.Items.Add(x.ToString()); listBox1.Items.Add(y.ToString());
Dim x As Integer Dim y As Integer Dim z As Integer Dim sff As FarPoint.Win.Spread.SearchFoundFlags sff = FpSpread1.Search(0, "test", False, False, False, False, True, False, False, True, 0, 1, 3, 3, x, y) ListBox1.Items.Add(sff.ToString()) ListBox1.Items.Add(x) ListBox1.Items.Add(y)
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