Class PdfViewerSearchSettings

Represents an object which configures the search functionality in RadPdfViewer.

Inheritance

System.Object

PdfViewerSearchSettings

Namespace: Telerik.Maui.Controls.PdfViewer

Assembly: Telerik.Maui.Controls.dll

Syntax

public class PdfViewerSearchSettings : BindableObject

Constructors

PdfViewerSearchSettings()

Declaration

public PdfViewerSearchSettings()

Fields

IsBusyProperty

Identifies the IsBusy property.

Declaration

public static readonly BindableProperty IsBusyProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

MainSearchResultFillProperty

Identifies the MainSearchResultFill property.

Declaration

public static readonly BindableProperty MainSearchResultFillProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

SearchOptionsProperty

Identifies the SearchOptions property.

Declaration

public static readonly BindableProperty SearchOptionsProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

SearchResultsFillProperty

Identifies the SearchResultsFill property.

Declaration

public static readonly BindableProperty SearchResultsFillProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

SearchResultsStringFormatProperty

Identifies the SearchResultsStringFormat property.

Declaration

public static readonly BindableProperty SearchResultsStringFormatProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

TextProperty

Identifies the Text property.

Declaration

public static readonly BindableProperty TextProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

TextSearchResultProperty

Identifies the TextSearchResult property.

Declaration

public static readonly BindableProperty TextSearchResultProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

TextSearchTriggerProperty

Identifies the TextSearchTrigger property.

Declaration

public static readonly BindableProperty TextSearchTriggerProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

TextSearchWorkerProperty

Identifies the TextSearchWorker property.

Declaration

public static readonly BindableProperty TextSearchWorkerProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

Properties

IsBusy

Gets a value indicating whether or not a search operation is in progress.

Declaration

public bool IsBusy { get; }

Property Value

System.Boolean

MainSearchResultFill

Gets or sets the fill of the main search result.

Declaration

public Color MainSearchResultFill { get; set; }

Property Value

Microsoft.Maui.Graphics.Color

PdfViewer

Gets the RadPdfViewer control these settings are associated with.

Declaration

public RadPdfViewer PdfViewer { get; }

Property Value

RadPdfViewer

SearchEntryToolbarItemText

Gets the text for the search entry PdfViewerSearchEntryToolbarItem.

Declaration

public string SearchEntryToolbarItemText { get; }

Property Value

System.String

SearchOptions

Gets or sets the Telerik.Windows.Documents.Fixed.Search.TextSearchOptions used to perform the search.

Declaration

public TextSearchOptions SearchOptions { get; set; }

Property Value

Telerik.Windows.Documents.Fixed.Search.TextSearchOptions

SearchResultsFill

Gets or sets the fill of all search results, except the main result.

Declaration

public Color SearchResultsFill { get; set; }

Property Value

Microsoft.Maui.Graphics.Color

SearchResultsStringFormat

The string format used to display search results in PdfViewerSearchContentView. The default value is "{0}{1}{2}" which results in strings like '1 of 5', where

• '1' means the first result is currently selected
• ' of ' is a localizable string
• '5' is the total number of search results.

Declaration

public string SearchResultsStringFormat { get; set; }

Property Value

System.String

SearchResultsToolbarItemText

Gets the text for the search results LabelToolbarItem.

Declaration

public string SearchResultsToolbarItemText { get; }

Property Value

System.String

Text

Gets or sets the text to search for.

Declaration

public string Text { get; set; }

Property Value

System.String

TextSearchResult

Gets a value representing the current search result. This property contains all the results that are found and the main result. The value of this property is null when no search was performed. The value of this property is NotFound when no results are found.

Declaration

public PdfViewerTextSearchResult TextSearchResult { get; }

Property Value

PdfViewerTextSearchResult

TextSearchTrigger

Gets or sets a value, indicating how search will be triggered in RadPdfViewer.

Declaration

public PdfViewerSearchTrigger TextSearchTrigger { get; set; }

Property Value

PdfViewerSearchTrigger

TextSearchWorker

The object that performs the text search and notifies for the search progress changes.

Declaration

public PdfViewerTextSearchWorker TextSearchWorker { get; set; }

Property Value

PdfViewerTextSearchWorker

Methods

CancelSearch()

Cancels the search operation.

Declaration

public void CancelSearch()

GetToastInfoForToolbarItem()

Override this method to customize the text in the notification toast based on the search state. This means to take into consideration things like the current TextSearchResult, the last searched Text, whether or not searching is in progress (IsBusy), and other information from the RadPdfViewer and the .

Declaration

public virtual PdfViewerSearchToastInfo GetToastInfoForToolbarItem()

Returns

PdfViewerSearchToastInfo

OnPropertyChanged(String)

Declaration

protected override void OnPropertyChanged(string propertyName = null)

Parameters

System.String propertyName

SearchAsync(String, TextSearchOptions)

Starts an async search operation with the provided text and options. For finer control use the TextSearchWorker property.

Declaration

public void SearchAsync(string text, TextSearchOptions searchOptions = null)

Parameters

System.String text

Telerik.Windows.Documents.Fixed.Search.TextSearchOptions searchOptions

Extension Methods

AndroidTypeConversionExtensions.ToJavaObject(Object)