Class TextSearch

Provides functionality for searching text in PDF documents.

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)

Creates a new instance of the TextSearch class.

Declaration
public TextSearch(RadFixedDocument fixedDocument)
Parameters
RadFixedDocument fixedDocument

The PDF document to be searched.

Methods

Find(String, TextSearchOptions)

Finds a specific text within the document.

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 a specific text within the document.

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 a specific text within the document.

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 in the document.

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 in the document from a specific position.

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 in the document within a specific range.

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 result.

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 result from a known 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 position in range. The search is executed in backward - the StartPosition of the range is greater than the EndPosition of the range.

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.

Extension Methods