Class
SearchResult

Describes a single successful text match, exposing its range, extracted string value, and convenience helpers for layout info.

Definition

Namespace:Telerik.Windows.Documents.Fixed.Search

Assembly:Telerik.Windows.Documents.Fixed.dll

Syntax:

cs-api-definition
public class SearchResult

Inheritance: objectSearchResult

Properties

NotFound

Gets a sentinel instance returned when no match is found.

Declaration

cs-api-definition
public static SearchResult NotFound { get; }

Property Value

SearchResult

The value represents a default SearchResult instance when there is no search result found.

Range

Gets the range spanning the matched text in the document.

Declaration

cs-api-definition
public TextRange Range { get; }

Property Value

TextRange

The value represents a TextRange object describing the start and end positions of the match.

Result

Gets the textual content of the match extracted from the document.

Declaration

cs-api-definition
public string Result { get; }

Property Value

string

A string value representing the match.

Methods

GetResultPage()

Gets the fixed page containing the match.

Declaration

cs-api-definition
public RadFixedPage GetResultPage()

Returns

RadFixedPage

The page containing the search result.

GetWordBoundingRect()

Gets the layout bounding rectangle of the first word in the match (for hit highlighting).

Declaration

cs-api-definition
public Rect GetWordBoundingRect()

Returns

Rect

Returns the bounding rectangle of the result word.

ToString()

Returns the matched string value.

Declaration

cs-api-definition
public override string ToString()

Returns

string

A string that represents the current object.

Overrides object.ToString()