New to Telerik UI for WinForms? Start a free 30-day trial

SearchResult

Class

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

Definition

Assembly:Telerik.Windows.Documents.Fixed.dll

Syntax:

public class SearchResult

Inheritance: objectSearchResult

Gets a sentinel instance returned when no match is found.

public static SearchResult NotFound { get; }

Property Value:

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

Gets the range spanning the matched text in the document.

public TextRange Range { get; }

Property Value:

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

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

public string Result { get; }

Property Value:

A string value representing the match.

Gets the fixed page containing the match.

public RadFixedPage GetResultPage()

Returns:

The page containing the search result.

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

public Rect GetWordBoundingRect()

Returns:

Returns the bounding rectangle of the result word.

Returns the matched string value.

public override string ToString()

Returns:

A string that represents the current object.

Overrides: object.ToString()