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

Searches the text in the specified range of header cells in the specified sheet for the specified string with the specified criteria, the start and end locations, and whether to include notes and tags.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Function SearchHeaders( _
   ByVal sheetIndex As Integer, _
   ByVal searchString As String, _
   ByVal searchRowHeaders As Boolean, _
   ByVal caseSensitive As Boolean, _
   ByVal exactMatch As Boolean, _
   ByVal alternateSearch As Boolean, _
   ByVal useWildcards As Boolean, _
   ByVal includeCellText 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

'Usage
 
Dim instance As FpSpread
Dim sheetIndex As Integer
Dim searchString As String
Dim searchRowHeaders As Boolean
Dim caseSensitive As Boolean
Dim exactMatch As Boolean
Dim alternateSearch As Boolean
Dim useWildcards As Boolean
Dim includeCellText 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.SearchHeaders(sheetIndex, searchString, searchRowHeaders, caseSensitive, exactMatch, alternateSearch, useWildcards, includeCellText, includeNotes, includeTags, startRowIndex, startColumnIndex, endRowIndex, endColumnIndex, foundRowIndex, foundColumnIndex)

public SearchFoundFlags SearchHeaders( 
   int sheetIndex,
   string searchString,
   bool searchRowHeaders,
   bool caseSensitive,
   bool exactMatch,
   bool alternateSearch,
   bool useWildcards,
   bool includeCellText,
   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
searchRowHeaders: Whether to search row headers instead of column headers
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
includeCellText: Whether the search includes the content in the cell
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.

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, false, false, false, false, true, false, 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

' Form Load
FpSpread1.Sheets(0).RowHeader.Cells(0, 0).Text = "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 sff As FarPoint.Win.Spread.SearchFoundFlags
sff = FpSpread1.SearchHeaders(0, "test", True, False, False, False, False, True, False, False, 0, 0, 5, 5, x, y)
ListBox1.Items.Add(sff.ToString())
ListBox1.Items.Add(x)
ListBox1.Items.Add(y)
End Sub

Reference

FpSpread Class
FpSpread Members
Overload List