ClassTextSearch
Performs forward and backward text searches over a fixed document using KMP or regular expression strategies with whole-word and case sensitivity options.
Definition
Namespace:Telerik.Windows.Documents.Fixed.Search
Assembly:Telerik.Windows.Documents.Fixed.dll
Syntax:
public class TextSearchInheritance: objectTextSearch
Constructors
TextSearch(RadFixedDocument)
Initializes a search context for the specified fixed document, preparing page text using the provided recognizer.
Declaration
public TextSearch(RadFixedDocument fixedDocument)Parameters
fixedDocument
The PDF document to be searched.
Methods
Find(string, TextSearchOptions)
Finds the next occurrence of the specified text starting from the internal search cursor and returns its range.
Declaration
public SearchResult Find(string text, TextSearchOptions options)Parameters
text
The searched text.
options
Allows you to specify the search options.
Returns
The SearchResult.
Find(string, TextSearchOptions, TextPosition)
Finds the next occurrence of the specified text starting from a provided position.
Declaration
public SearchResult Find(string text, TextSearchOptions options, TextPosition startPosition)Parameters
text
The searched text.
options
Allows you to specify the search options.
startPosition
The initial position to start the search from.
Returns
The SearchResult.
Find(string, TextSearchOptions, TextRange)
Finds the next occurrence within the specified forward range.
Declaration
public SearchResult Find(string text, TextSearchOptions options, TextRange range)Parameters
text
The searched text.
options
Allows you to specify the search options.
range
The range within the search is performed
Returns
The SearchResult.
FindAll(string, TextSearchOptions)
Finds all occurrences of the text throughout the document starting at the beginning.
Declaration
public IEnumerable<SearchResult> FindAll(string text, TextSearchOptions options)Parameters
text
The searched text.
options
The search options to apply for the current search.
Returns
A collection of the found results.
FindAll(string, TextSearchOptions, TextPosition)
Finds all occurrences starting from the provided position and continuing forward.
Declaration
public IEnumerable<SearchResult> FindAll(string text, TextSearchOptions options, TextPosition startPosition)Parameters
text
The searched text.
options
The search options to apply for the current search.
startPosition
The position from which to start the search.
Returns
A collection of the found results.
FindAll(string, TextSearchOptions, TextRange)
Finds all occurrences inside the specified range using the configured strategy.
Declaration
public IEnumerable<SearchResult> FindAll(string text, TextSearchOptions options, TextRange range)Parameters
text
The searched text.
options
The search options to apply for the current search.
range
The range to search in.
Returns
A collection of the found results.
FindPrevious(string, TextSearchOptions)
Finds the previous occurrence of the specified text relative to the internal cursor.
Declaration
public SearchResult FindPrevious(string text, TextSearchOptions options)Parameters
text
The text to be searched.
options
The search options to apply for the current search.
Returns
The SearchResult.
FindPrevious(string, TextSearchOptions, TextPosition)
Finds the previous occurrence starting from the provided position.
Declaration
public SearchResult FindPrevious(string text, TextSearchOptions options, TextPosition startPosition)Parameters
text
The text to be searched.
options
The search options to apply for the current search.
startPosition
The position to begin from.
Returns
The SearchResult.
FindPrevious(string, TextSearchOptions, TextRange)
Finds the previous occurrence within the specified backward range (start greater than end).
Declaration
public SearchResult FindPrevious(string text, TextSearchOptions options, TextRange range)Parameters
text
The text to be searched.
options
The search options to apply for the current search.
range
The range of the search - StartPosition is greater than EndPosition.
Returns
The SearchResult.