Search(Int32,String,Boolean,Boolean,Boolean,Boolean,Int32,Int32,Int32,Int32) Method

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

Syntax

Visual Basic
C#

'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

'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 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)

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

The entire string in which the specified string is found is returned.

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

Example

This example uses the Search method.

int x = 0;
int y = 0;
FpSpread1.Search(0,"test", false, false, false, false, 0,0,ref x,ref y);
ListBox1.Items.Add(x.ToString());
ListBox1.Items.Add(y.ToString());

Visual Basic

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 7, Windows 8, Windows Vista, Windows Server 2000, Windows 2000 Professional, Windows XP Professional, Windows NT 4.0 Workstation, SP6, Windows NT 4.0 Server, SP6

Reference

FpSpread Class
FpSpread Members
Overload List