.NET MAUI PDF Viewer Search Configuration

The Telerik UI for .NET MAUI PDF Viewer exposes SearchSettings property which you can use to configure the search functionality options, such as search criteria, commands, highlight colors, and so on.

This article lists the SearchSettings properties that allow you to customize the search.

Searching Text

Through the Text property of the SearchSettings you can retrieve or explicitly set the search text (in case you prefer not using the built-in search UI).

Searching Options

Define the search criteria by using the SearchOptions (of type Telerik.Windows.Documents.Fixed.Search.TextSearchOptions) and use it to define some search criteria as listed below:

• UseRegularExpression—Specifies whether a regular expression is used for searching.
• CaseSensitive—Indicates whether the search can be case sensitive.
• WholeWordsOnly—Indicates whether only whole words can be matched.

Triggering Search

By default, search operation occurs when the user clicks the Search button of the keyboard on mobile, and the Enter key of the physical keyboard on desktop. You can modify this behavior by setting the TextSearchTrigger property of the SearchSettings. TextSearchTrigger is an enum of type Telerik.Maui.Controls.PdfViewer.PdfViewerSearchTrigger, and you can use it to define when a search operation can be performed. The available options are:

• None—Programmatically calls the search operation.
• TextChanged—The search is triggered every time the Text is changed.
• Completed (default)—The search operation is triggered when the corresponding entry completes (by pressing Enter/Return key).

Search Results

You can get the search results by using the following properties:

• SearchResultsStringFormat (string)— The string format displays search results in Telerik.Maui.Controls.PdfViewer.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.

<telerik:RadPdfViewer x:Name="pdfViewer">
    <telerik:RadPdfViewer.SearchSettings>
        <telerik:PdfViewerSearchSettings SearchResultsStringFormat="Result: {0}, Total: {2}"/>
    </telerik:RadPdfViewer.SearchSettings>
</telerik:RadPdfViewer >

• TextSearchResult (property of the SearchSettings)—Retrieves the current search result. It contains the results that match the search as well as the main result. The main result is highlighted differently from the other search results and is used for navigation purposes, so that the user can navigate to previous and next results and keep track. The TextSearchResult exposes the following properties:
  • static TextSearchResult.NotFound property—Is Returned when the search criteria has no results;
  • SearchResults—Read-only collection of type Telerik.Windows.Documents.Fixed.Search.SearchResult which contains all the search results.
  • MainSearchResult—A reference to the search result that are the main result.

Search Results Highlight Colors

SearchSettings exposes two Color properties—MainSearchResultFill and SearchResultsFill. When a search is initiated, the found search results are highlighted. Two highlight colors are needed, one of all results has the MainSearchResultFill and is considered to be the main-result. This is for navigation purposes, so that a user can navigate to previous and next results and keep track. The rest of the results are colored in the SearchResultsFill.

Here is an example of how you can customize SearchOptions as well as highlight colors:

<Grid RowDefinitions="{OnIdiom Desktop='Auto, *', Phone='*, Auto'}">
    <telerik:RadPdfViewerToolbar Grid.Row="{OnIdiom Desktop=0, Phone=1}"
                                 PdfViewer="{x:Reference pdfViewer}">
        <telerik:PdfViewerSearchToolbarItem IsVisible="{OnIdiom Phone=False, Desktop=True}" />
        <telerik:PdfViewerSearchNavigationToolbarItem ToastStyle="{StaticResource ToastStyle}" IsVisible="{OnIdiom Phone=True, Desktop=False}" />
    </telerik:RadPdfViewerToolbar>
    <telerik:RadPdfViewer x:Name="pdfViewer"
                          Grid.Row="{OnIdiom Desktop=1, Phone=0}">
        <telerik:RadPdfViewer.SearchSettings>
            <telerik:PdfViewerSearchSettings MainSearchResultFill="#99FF7F7F"
                                             SearchResultsStringFormat="Result: {0}, Total: {2}"
                                             SearchResultsFill="#997FC9FF"
                                             TextSearchTrigger="TextChanged">
                <telerik:PdfViewerSearchSettings.SearchOptions>
                    <telerikTextSearch:TextSearchOptions>
                        <telerikTextSearch:TextSearchOptions.UseRegularExpression>
                            <x:Boolean>True</x:Boolean>
                        </telerikTextSearch:TextSearchOptions.UseRegularExpression>
                    </telerikTextSearch:TextSearchOptions>
                </telerik:PdfViewerSearchSettings.SearchOptions>
            </telerik:PdfViewerSearchSettings>
        </telerik:RadPdfViewer.SearchSettings>
    </telerik:RadPdfViewer>

Add the folowing namespaces:

xmlns:telerik="http://schemas.telerik.com/2022/xaml/maui"
xmlns:telerikTextSearch="clr-namespace:Telerik.Windows.Documents.Fixed.Search;assembly=Telerik.Documents.Fixed"

Methods

The Telerik UI for .NET MAUI PDF Viewer provides methods related to searching feature.

• SearchAsync—Starts an async search operation with the provided text and options.
• GetToastInfoForToolbarItem—Override this method to customize the text in the notification toast based on the search state.

For the runnable PDF Viewer Search Settings example, see the SDKBrowser Demo Application and go to PdfViewer > Search category.

See Also

• .NET MAUI PDF Viewer Forum Page
• Telerik .NET MAUI Blogs
• Telerik .NET MAUI Roadmap