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

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

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 setting, that specifies in what type of object the string was 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 SearchHeaders method.

// Page Load
FpSpread1.Sheets[0].RowHeader.Cells[0, 0].Text = "Row Header";
private void Button1_Click(object sender, System.EventArgs e)
{ 
int x = 0;
int y = 0;
FarPoint.Web.Spread.SearchFoundFlags sff;
sff = FpSpread1.SearchHeaders(0, "Row Header", true, ref x, ref y);
ListBox1.Items.Add(sff.ToString());
ListBox1.Items.Add(x.ToString());
ListBox1.Items.Add(y.ToString());
}

Visual Basic

' Page Load
FpSpread1.Sheets(0).RowHeader.Cells(0, 0).Text = "Row Header"

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 sff As FarPoint.Web.Spread.SearchFoundFlags
sff = FpSpread1.SearchHeaders(0, "Row Header", True, x, y)
ListBox1.Items.Add(sff.ToString())
ListBox1.Items.Add(x)
ListBox1.Items.Add(y)
End Sub

Requirements

Target Platforms: Windows 7, Windows 8, Windows 10, Windows Vista, Windows Server 2003, Windows Server 2008, Windows Server 2012, Windows XP Professional

Reference

FpSpread Class
FpSpread Members
Overload List