FarPoint.Web.Spread.FpSpread.Search

Search Method

Search(int, string, bool, bool, bool, bool, int, int, ref int, ref int)

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

Declaration

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)

Public Function Search(sheetIndex As Integer, searchString As String, caseSensitive As Boolean, exactMatch As Boolean, alternateSearch As Boolean, useWildcards As Boolean, startRowIndex As Integer, startColumnIndex As Integer, ByRef foundRowIndex As Integer, ByRef foundColumnIndex As Integer) As String

Parameters

Type	Name	Description
int	sheetIndex	Index of sheet on which to search
string	searchString	String for which to search
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
int	startRowIndex	Index of row at which to start
int	startColumnIndex	Index of column at which to start
int	foundRowIndex	Index of row at which match is found
int	foundColumnIndex	Index of column at which match is found

Returns

Type	Description
string

Search(int, string, bool, bool, bool, bool, int, int, int, int, ref int, ref int)

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

Declaration

public string Search(int sheetIndex, string searchString, bool caseSensitive, bool exactMatch, bool alternateSearch, bool useWildcards, int startRowIndex, int startColumnIndex, int endRowIndex, int endColumnIndex, ref int foundRowIndex, ref int foundColumnIndex)

Public Function Search(sheetIndex As Integer, searchString As String, caseSensitive As Boolean, exactMatch As Boolean, alternateSearch As Boolean, useWildcards As Boolean, startRowIndex As Integer, startColumnIndex As Integer, endRowIndex As Integer, endColumnIndex As Integer, ByRef foundRowIndex As Integer, ByRef foundColumnIndex As Integer) As String

Parameters

Type	Name	Description
int	sheetIndex	Index of sheet on which to search
string	searchString	String for which to search
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
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
string

Search(int, string, bool, bool, bool, bool, bool, bool, bool, int, int, ref int, ref int)

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

Declaration

public string Search(int sheetIndex, string searchString, bool caseSensitive, bool exactMatch, bool alternateSearch, bool useWildcards, bool includeCellText, bool includeNotes, bool includeTags, int startRowIndex, int startColumnIndex, ref int foundRowIndex, ref int foundColumnIndex)

Public Function Search(sheetIndex As Integer, searchString As String, 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, ByRef foundRowIndex As Integer, ByRef foundColumnIndex As Integer) As String

Parameters

Type	Name	Description
int	sheetIndex	Index of sheet on which to search
string	searchString	String for which to search
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 considers the cell text
bool	includeNotes	Whether the search considers cell notes
bool	includeTags	Whether the search considers cell tags
int	startRowIndex	Index of row at which to start
int	startColumnIndex	Index of column at which to start
int	foundRowIndex	Index of row at which match is found
int	foundColumnIndex	Index of column at which match is found

Returns

Type	Description
string

Search(int, string, bool, bool, bool, bool, bool, bool, int, int, int, int, ref int, ref int)

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

Declaration

public SearchFoundFlags Search(int sheetIndex, string searchString, bool caseSensitive, bool exactMatch, bool alternateSearch, bool useWildcards, bool includeNotes, bool includeTags, int startRowIndex, int startColumnIndex, int endRowIndex, int endColumnIndex, ref int foundRowIndex, ref int foundColumnIndex)

Public Function Search(sheetIndex As Integer, searchString As String, caseSensitive As Boolean, exactMatch As Boolean, alternateSearch As Boolean, useWildcards 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	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	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

Search(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 cells in the specified sheet
for the specified string with the specified criteria.

Declaration

public SearchFoundFlags Search(int sheetIndex, string searchString, bool caseSensitive, bool exactMatch, bool alternateSearch, bool useWildcards, bool includeCellText, bool includeNotes, bool includeTags, bool searchAsBlockRange, int startRowIndex, int startColumnIndex, int endRowIndex, int endColumnIndex, ref int foundRowIndex, ref int foundColumnIndex)

Public Function Search(sheetIndex As Integer, searchString As String, caseSensitive As Boolean, exactMatch As Boolean, alternateSearch As Boolean, useWildcards As Boolean, includeCellText As Boolean, includeNotes As Boolean, includeTags As Boolean, searchAsBlockRange 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	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
bool	searchAsBlockRange	Whether to search as range
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

Search(int, int, string, bool, bool, bool, bool, bool, bool, bool, int, int, int, int, ref int, ref int, ref int)

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

Declaration

public SearchFoundFlags Search(int startSheetIndex, int endSheetIndex, string searchString, bool caseSensitive, bool exactMatch, bool alternateSearch, bool useWildcards, bool includeCellText, bool includeNotes, bool includeTags, int startRowIndex, int startColumnIndex, int endRowIndex, int endColumnIndex, ref int foundSheetIndex, ref int foundRowIndex, ref int foundColumnIndex)

Public Function Search(startSheetIndex As Integer, endSheetIndex As Integer, searchString As String, 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 foundSheetIndex As Integer, ByRef foundRowIndex As Integer, ByRef foundColumnIndex As Integer) As SearchFoundFlags

Parameters

Type	Name	Description
int	startSheetIndex	Index of sheet on which to start search
int	endSheetIndex	Index of sheet on which to end search
string	searchString	String for which to search
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	foundSheetIndex	Index of sheet at which match is found
int	foundRowIndex	Index of row at which match is found
int	foundColumnIndex	Index of column at which match is found

Returns

Type	Description
SearchFoundFlags