Syntax
| 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 includeNotes As Boolean, _ ByVal includeTags 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 | |
| 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 includeNotes As Boolean Dim includeTags 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, includeNotes, includeTags, startRowIndex, startColumnIndex, endRowIndex, endColumnIndex, foundRowIndex, foundColumnIndex) | |
| C# | |
|---|---|
public SearchFoundFlags Search( int sheetIndex, string searchString, bool caseSensitive, bool exactMatch, bool alternateSearch, bool useWildcards, bool includeNotes, bool includeTags, int startRowIndex, int startColumnIndex, int endRowIndex, int endColumnIndex, 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
- 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
- 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
- foundRowIndex
- Index of row at which match is found
- foundColumnIndex
- Index of column at which match is found
Return Value
SearchFoundFlags settings indicating in what type cell or cell item the string is found is returned.Also, the foundRowIndex and foundColumnIndex return the row index and column index of the cell in which the string is found.
Remarks
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. This search method always searches the data cells. You also optionally can search the cell notes and tags. 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.
Example
This example searches for a note.
| C# | Copy Code |
|---|---|
// Form Load fpSpread1.Sheets[0].Cells[0, 1].NoteStyle = FarPoint.Win.Spread.NoteStyle.PopupNote; fpSpread1.Sheets[0].Cells[0, 1].Note = "test"; private void button1_Click(object sender, System.EventArgs e) { int x = 0; int y = 0; FarPoint.Win.Spread.SearchFoundFlags sff; sff = fpSpread1.Search(0, "test", false, false, false, false, true, false, 0, 0, 5, 5, ref x, ref y); listBox1.Items.Add(sff.ToString()); listBox1.Items.Add(x.ToString()); listBox1.Items.Add(y.ToString()); } | |
| Visual Basic | Copy Code |
|---|---|
' Form Load FpSpread1.Sheets(0).Cells(0, 1).NoteStyle = FarPoint.Win.Spread.NoteStyle.PopupNote FpSpread1.Sheets(0).Cells(0, 1).Note = "test" Private Sub Button1_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles Button1.Click 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, 0, 0, 5, 5, x, y) ListBox1.Items.Add(sff.ToString()) ListBox1.Items.Add(x) ListBox1.Items.Add(y) End Sub | |
Requirements
Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2