SearchHeaders(Int32,String,Boolean,Int32,Int32) Method

Searches the text in the header cells in the specified sheet for the specified string.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Function SearchHeaders( _
   ByVal sheetIndex As Integer, _
   ByVal searchString As String, _
   ByVal searchRowHeaders As Boolean, _
   ByRef foundRowIndex As Integer, _
   ByRef foundColumnIndex As Integer _
) As SearchFoundFlags

'Usage
 
Dim instance As FpSpread
Dim sheetIndex As Integer
Dim searchString As String
Dim searchRowHeaders As Boolean
Dim foundRowIndex As Integer
Dim foundColumnIndex As Integer
Dim value As SearchFoundFlags
 
value = instance.SearchHeaders(sheetIndex, searchString, searchRowHeaders, foundRowIndex, foundColumnIndex)

public SearchFoundFlags SearchHeaders( 
   int sheetIndex,
   string searchString,
   bool searchRowHeaders,
   ref int foundRowIndex,
   ref int foundColumnIndex
)

Parameters

sheetIndex: Index of sheet on which to search
searchString: String for which to search
searchRowHeaders: Whether to search row headers instead of column headers
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.

Example

This example searches the text in the row header.

// Form Load
fpSpread1.Sheets[0].RowHeader.Cells[0, 0].Text = "test";

private void button1_Click(object sender, System.EventArgs e)
{
int x = 0;  
int y = 0; 
FarPoint.Win.Spread.SearchFoundFlags sff; 
sff = fpSpread1.SearchHeaders(0, "test", true, ref x, ref y);
listBox1.Items.Add(sff.ToString()); 
listBox1.Items.Add(x.ToString()); 
listBox1.Items.Add(y.ToString()); 
}

Visual Basic

' Form Load
FpSpread1.Sheets(0).RowHeader.Cells(0, 0).Text = "test"

Dim x As Integer
Dim y As Integer
Dim sff As FarPoint.Win.Spread.SearchFoundFlags
sff = FpSpread1.SearchHeaders(0, "test", True, x, y)
ListBox1.Items.Add(sff.ToString())
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

Reference

FpSpread Class
FpSpread Members
Overload List