FarPoint.Win.Spread.FpSpread.SearchHeaders

SearchHeaders Method

SearchHeaders(int, string, bool, ref int, ref int)

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

Declaration

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

Public Function SearchHeaders(sheetIndex As Integer, searchString As String, searchRowHeaders As Boolean, ByRef foundRowIndex As Integer, ByRef foundColumnIndex As Integer) As SearchFoundFlags

Parameters

Type	Name	Description
int	sheetIndex	Index of sheet on which to search
string	searchString	String for which to search
bool	searchRowHeaders	Whether to search row headers instead of column headers
int	foundRowIndex	Index of row at which match is found
int	foundColumnIndex	Index of column at which match is found

Returns

Type	Description
SearchFoundFlags

SearchHeaders(int, string, bool, bool, bool, bool, bool, bool, bool, bool, int, int, int, int, ref int, ref int)

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.

Declaration

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)

Public Function SearchHeaders(sheetIndex As Integer, searchString As String, searchRowHeaders As Boolean, caseSensitive As Boolean, exactMatch As Boolean, alternateSearch As Boolean, useWildcards As Boolean, includeCellText As Boolean, includeNotes As Boolean, includeTags As Boolean, startRowIndex As Integer, startColumnIndex As Integer, endRowIndex As Integer, endColumnIndex As Integer, ByRef foundRowIndex As Integer, ByRef foundColumnIndex As Integer) As SearchFoundFlags

Parameters

Type	Name	Description
int	sheetIndex	Index of sheet on which to search
string	searchString	String for which to search
bool	searchRowHeaders	Whether to search row headers instead of column headers
bool	caseSensitive	Whether the search considers the case of the letters in the search string
bool	exactMatch	Whether the search considers only an exact match
bool	alternateSearch	Whether the search goes by alternate coordinates of column, row (instead of row, column)
bool	useWildcards	Whether the search considers wildcard characters (*, ?) in the search string
bool	includeCellText	Whether the search includes the content in the cell
bool	includeNotes	Whether the search includes the content in the cell notes
bool	includeTags	Whether the search includes the content in the cell tags or their string representations
int	startRowIndex	Index of row at which to start
int	startColumnIndex	Index of column at which to start
int	endRowIndex	Index of row at which to end
int	endColumnIndex	Index of column at which to end
int	foundRowIndex	Index of row at which match is found
int	foundColumnIndex	Index of column at which match is found

Returns

Type	Description
SearchFoundFlags

SearchHeaders Method