Spread Windows Forms 7.0 Product Documentation
Search(Int32,String,Boolean,Boolean,Boolean,Boolean,Int32,Int32,Int32,Int32) Method
See Also  Example Support Options
FarPoint.Win.Spread Assembly > FarPoint.Win.Spread Namespace > FpSpread Class > Search Method : Search(Int32,String,Boolean,Boolean,Boolean,Boolean,Int32,Int32,Int32,Int32) Method


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
startRowIndex
Index of row at which to start
startColumnIndex
Index of column at which to start
foundRowIndex
Index of row at which match is found
foundColumnIndex
Index of column at which match is found

Glossary Item Box

Searches the text in the cells in the specified sheet for the specified string with the specified criteria.

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 startRowIndex As Integer, _
   ByVal startColumnIndex As Integer, _
   ByRef foundRowIndex As Integer, _
   ByRef foundColumnIndex As Integer _
) As String
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 startRowIndex As Integer
Dim startColumnIndex As Integer
Dim foundRowIndex As Integer
Dim foundColumnIndex As Integer
Dim value As String
 
value = instance.Search(sheetIndex, searchString, caseSensitive, exactMatch, alternateSearch, useWildcards, startRowIndex, startColumnIndex, foundRowIndex, foundColumnIndex)
C# 
public string Search( 
   int sheetIndex,
   string searchString,
   bool caseSensitive,
   bool exactMatch,
   bool alternateSearch,
   bool useWildcards,
   int startRowIndex,
   int startColumnIndex,
   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
startRowIndex
Index of row at which to start
startColumnIndex
Index of column at which to start
foundRowIndex
Index of row at which match is found
foundColumnIndex
Index of column at which match is found

Return Value

String containing the text in the cell where the search string is found, or null if not found in a cell, is returned.

Also, the foundRowIndex and foundColumnIndex return the row index and column index of the cell in which the string is found.

Remarks

This search method starts at the cell location specified (with startRowIndex and startColumnIndex) and goes to the end of the sheet until the cell is found that contains the search string. This is the most basic of the search methods.

This search method has these qualifications:

  • 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
  • Only checks the formatted string, that is the Text in the cell, not the Value
  • Only searches the cells in the data area, not the headers
  • Only searches the specified cells in one sheet
  • Cell notes and cell tags are not searched

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.

This method is for backward compatibility with previous versions that could not search headers, notes, and tags. If you are searching these, you may use the other Search methods that return both the search found flag (SearchFoundFlag) as well as the cell location.

Example

This example performs a search on the sheet, finds the cell that matches, and lists the row and column indexes of that cell.
C#Copy Code
int x = 0; 
int y = 0;
fpSpread1.Search(0, "test", false, false, false, false, 0, 0, ref x, ref y);
listBox1.Items.Add(x);
listBox1.Items.Add(y);
Visual BasicCopy Code
Dim x As Integer 
Dim y As Integer
FpSpread1.Search(0, "test", False, False, False, False, 0, 0, x, y)
ListBox1.Items.Add(x)
ListBox1.Items.Add(y)

Requirements

Target Platforms: Windows 2000 Professional (SP4), Windows 2000 Server, Windows 2003 Server (SP1), Windows 2008, Windows XP (SP2), Windows Vista, Windows 7, Windows 8

See Also

© 2002-2014 ComponentOne, a division of GrapeCity. All Rights Reserved.