FarPoint.Win.Spread.FpSpread.Search

Search Method

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	Sheet index 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
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	Sheet index 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	Row index at which to start
int	startColumnIndex	Column index at which to start
int	endRowIndex	Row index at which to end
int	endColumnIndex	Column index at which to end
int	foundRowIndex	Row index at which match is found
int	foundColumnIndex	Column index 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	Sheet index 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	Specifies whether to search the specified block of cells only
int	startRowIndex	Row Index at which to start
int	startColumnIndex	Column index at which to start
int	endRowIndex	Row Index at which to end
int	endColumnIndex	Column index at which to end
int	foundRowIndex	Row Index at which match is found
int	foundColumnIndex	Column index 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	Sheet index on which to start the search
int	endSheetIndex	Sheet index on which to end the 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	Row index at which to start
int	startColumnIndex	Column index at which to start
int	endRowIndex	Row index at which to end
int	endColumnIndex	Column index at which to end
int	foundSheetIndex	Sheet index at which the match is found
int	foundRowIndex	Row index at which the match is found
int	foundColumnIndex	Column index at which the match is found

Returns

Type	Description
SearchFoundFlags

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, bool, int, int, int, int, bool, ref int, ref int)

Searches the text in the cells in the specified sheet for the specified string with the specified criteria and the location to start and end, and whether to search notes and tags as well.

Declaration

public SearchFoundFlags Search(int sheetIndex, string searchString, bool caseSensitive, bool exactMatch, bool alternateSearch, bool useWildcards, bool includeCellText, bool includeNotes, bool includeTags, bool reverseSearching, int startRowIndex, int startColumnIndex, int endRowIndex, int endColumnIndex, bool searchAsBlockRange, 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, reverseSearching As Boolean, startRowIndex As Integer, startColumnIndex As Integer, endRowIndex As Integer, endColumnIndex As Integer, searchAsBlockRange 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	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	reverseSearching	Whether the search is in reversed order
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
bool	searchAsBlockRange	Specifies whether to search the specified block of cells only
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 Method