Class TextSearch

Performs forward and backward text searches over a fixed document using KMP or regular expression strategies with whole-word and case sensitivity options.

Inheritance

System.Object

TextSearch

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Telerik.Windows.Documents.Fixed.Search

Assembly: Telerik.Windows.Documents.Fixed.dll

Syntax

public class TextSearch

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

RadFixedDocument 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

System.String text The searched text.

TextSearchOptions options Allows you to specify the search options.

Returns

SearchResult 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

System.String text The searched text.

TextSearchOptions options Allows you to specify the search options.

TextPosition startPosition The initial position to start the search from.

Returns

SearchResult 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

System.String text The searched text.

TextSearchOptions options Allows you to specify the search options.

TextRange range The range within the search is performed

Returns

SearchResult 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

System.String text The searched text.

TextSearchOptions options The search options to apply for the current search.

Returns

System.Collections.Generic.IEnumerable<SearchResult> 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

System.String text The searched text.

TextSearchOptions options The search options to apply for the current search.

TextPosition startPosition The position from which to start the search.

Returns

System.Collections.Generic.IEnumerable<SearchResult> 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

System.String text The searched text.

TextSearchOptions options The search options to apply for the current search.

TextRange range The range to search in.

Returns

System.Collections.Generic.IEnumerable<SearchResult> 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

System.String text The text to be searched.

TextSearchOptions options The search options to apply for the current search.

Returns

SearchResult 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

System.String text The text to be searched.

TextSearchOptions options The search options to apply for the current search.

TextPosition startPosition The position to begin from.

Returns

SearchResult 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

System.String text The text to be searched.

TextSearchOptions options The search options to apply for the current search.

TextRange range The range of the search - StartPosition is greater than EndPosition.

Returns

SearchResult The SearchResult.