Back to all docs
API Reference / Telerik.Maui.Controls / RadPdfViewer
New to Telerik UI for .NET MAUI? Start a free 30-day trial

RadPdfViewer

Class

A comprehensive PDF document viewer control for .NET MAUI applications that provides rich document display, navigation, zooming, text search, text selection, and interactive features. The RadPdfViewer offers professional-grade PDF viewing capabilities with extensive customization options and seamless integration with complementary controls.

Definition

Namespace:Telerik.Maui.Controls

Assembly:Telerik.Maui.Controls.dll

Syntax:
C#
public class RadPdfViewer : RadLayout

Inheritance: objectRadLayoutRadPdfViewer

Inherited Members RadLayout.CreateLayoutManager()

Constructors

RadPdfViewer()

Initializes a new instance of the RadPdfViewer class.

C#
public RadPdfViewer()

Fields

BackgroundColorProperty

BindableProperty

Identifies the BackgroundColor property.

C#
public static readonly BindableProperty BackgroundColorProperty

BusyIndicatorTemplateProperty

BindableProperty

Identifies the BusyIndicatorTemplate property.

C#
public static readonly BindableProperty BusyIndicatorTemplateProperty

CloseSearchViewCommandProperty

BindableProperty

Identifies the CloseSearchViewCommand property.

C#
public static readonly BindableProperty CloseSearchViewCommandProperty

DocumentProperty

BindableProperty

Identifies the Document property.

C#
public static readonly BindableProperty DocumentProperty

DoubleTappedCommandProperty

BindableProperty

Identifies the DoubleTappedCommand property.

C#
public static readonly BindableProperty DoubleTappedCommandProperty

FitToWidthCommandProperty

BindableProperty

Identifies the FitToWidthCommand property.

C#
public static readonly BindableProperty FitToWidthCommandProperty

LayoutModeProperty

BindableProperty

Identifies the LayoutMode property.

C#
public static readonly BindableProperty LayoutModeProperty

MaxZoomLevelProperty

BindableProperty

Identifies the MaxZoomLevel property.

C#
public static readonly BindableProperty MaxZoomLevelProperty

MinZoomLevelProperty

BindableProperty

Identifies the MinZoomLevel property.

C#
public static readonly BindableProperty MinZoomLevelProperty

NavigateToNextPageCommandProperty

BindableProperty

Identifies the NavigateToNextPageCommand property.

C#
public static readonly BindableProperty NavigateToNextPageCommandProperty

NavigateToNextSearchResultCommandProperty

BindableProperty

Identifies the NavigateToNextSearchResultCommand property.

C#
public static readonly BindableProperty NavigateToNextSearchResultCommandProperty

NavigateToPageCommandProperty

BindableProperty

Identifies the NavigateToPageCommand property.

C#
public static readonly BindableProperty NavigateToPageCommandProperty

NavigateToPreviousPageCommandProperty

BindableProperty

Identifies the NavigateToPreviousPageCommand property.

C#
public static readonly BindableProperty NavigateToPreviousPageCommandProperty

NavigateToPreviousSearchResultCommandProperty

BindableProperty

Identifies the NavigateToPreviousSearchResultCommand property.

C#
public static readonly BindableProperty NavigateToPreviousSearchResultCommandProperty

OpenSearchViewCommandProperty

BindableProperty

Identifies the OpenSearchViewCommand property.

C#
public static readonly BindableProperty OpenSearchViewCommandProperty

PageSpacingProperty

BindableProperty

Identifies the PageSpacing property.

C#
public static readonly BindableProperty PageSpacingProperty

SearchSettingsProperty

BindableProperty

Identifies the SearchSettings property.

C#
public static readonly BindableProperty SearchSettingsProperty

SelectionSettingsProperty

BindableProperty

Identifies the SelectionSettings property.

C#
public static readonly BindableProperty SelectionSettingsProperty

SourceExceptionTemplateProperty

BindableProperty

Identifies the SourceExceptionTemplate property.

C#
public static readonly BindableProperty SourceExceptionTemplateProperty

SourceProperty

BindableProperty

Identifies the Source property.

C#
public static readonly BindableProperty SourceProperty

ToggleLayoutModeCommandProperty

BindableProperty

Identifies the ToggleLayoutModeCommand property.

C#
public static readonly BindableProperty ToggleLayoutModeCommandProperty

ViewportProperty

BindableProperty

Identifies the Viewport property.

C#
public static readonly BindableProperty ViewportProperty

VisiblePagesCountProperty

BindableProperty

Identifies the VisiblePagesCount property.

C#
public static readonly BindableProperty VisiblePagesCountProperty

VisiblePagesStartIndexProperty

BindableProperty

Identifies the VisiblePagesStartIndex property.

C#
public static readonly BindableProperty VisiblePagesStartIndexProperty

ZoomInCommandProperty

BindableProperty

Identifies the ZoomInCommand property.

C#
public static readonly BindableProperty ZoomInCommandProperty

ZoomLevelProperty

BindableProperty

Identifies the ZoomLevel property.

C#
public static readonly BindableProperty ZoomLevelProperty

ZoomOutCommandProperty

BindableProperty

Identifies the ZoomOutCommand property.

C#
public static readonly BindableProperty ZoomOutCommandProperty

Properties

BackgroundColor

Color

Gets or sets the background color of the PDF viewer.

C#
public Color BackgroundColor { get; set; }

BusyIndicatorTemplate

DataTemplate

Gets or sets the template for the busy indicator displayed during document loading.

C#
public DataTemplate BusyIndicatorTemplate { get; set; }

CloseSearchViewCommand

Gets or sets the ICommand which closes the PdfViewerSearchContentView.

C#
public ICommand CloseSearchViewCommand { get; set; }

Document

RadFixedDocument

Gets the currently loaded PDF document.

C#
public RadFixedDocument Document { get; }

DoubleTappedCommand

Gets or sets the command executed when the viewer is double-tapped. The parameter of this command is of type Point and it represents the relative position of the tap, i.e. values between 0 and 1 in the scope of the PdfViewer.

C#
public ICommand DoubleTappedCommand { get; set; }

EnableHardwareAcceleration

Gets a value indicating whether the GPU should be used for rendering. When set to true, is used and rendering is performed using the GPU. When set to false, is used and rendering is performed using the CPU.

C#
public bool EnableHardwareAcceleration { get; set; }

FitToWidthCommand

Gets or sets the command to fit the document to width.

C#
public ICommand FitToWidthCommand { get; set; }

LayoutMode

Gets or sets the layout mode for displaying PDF pages.

C#
public LayoutMode LayoutMode { get; set; }

MaxZoomLevel

Gets or sets the maximum zoom level allowed.

C#
public double MaxZoomLevel { get; set; }

MinZoomLevel

Gets or sets the minimum zoom level allowed.

C#
public double MinZoomLevel { get; set; }

NavigateToNextPageCommand

Gets or sets the command to navigate to the next page.

C#
public ICommand NavigateToNextPageCommand { get; set; }

NavigateToNextSearchResultCommand

Gets the ICommand executed when navigating to the next search result.

C#
public ICommand NavigateToNextSearchResultCommand { get; }

NavigateToPageCommand

Gets or sets the command to navigate to a specific page. The parameter of this command is of type int and it represents the page index.

C#
public ICommand NavigateToPageCommand { get; set; }

NavigateToPreviousPageCommand

Gets or sets the command to navigate to the previous page.

C#
public ICommand NavigateToPreviousPageCommand { get; set; }

NavigateToPreviousSearchResultCommand

Gets the ICommand executed when navigating to the previous search result.

C#
public ICommand NavigateToPreviousSearchResultCommand { get; }

OpenSearchViewCommand

Gets or sets the ICommand which opens the PdfViewerSearchContentView.

C#
public ICommand OpenSearchViewCommand { get; set; }

PageSpacing

Gets or sets the spacing between pages in continuous layout mode.

C#
public double PageSpacing { get; set; }

SearchContentView

Gets the search content view for the PDF viewer.

C#
public PdfViewerSearchContentView SearchContentView { get; }

SearchSettings

Gets or sets the settings for search functionality in the PDF viewer.

C#
public PdfViewerSearchSettings SearchSettings { get; set; }

SelectionSettings

Gets or sets the settings for text selection in the PDF viewer.

C#
public PdfViewerSelectionSettings SelectionSettings { get; set; }

Source

Gets or sets the document source for the PDF viewer.

C#
public DocumentSource Source { get; set; }

SourceExceptionTemplate

DataTemplate

Gets or sets the template for displaying source exceptions.

C#
public DataTemplate SourceExceptionTemplate { get; set; }

ToggleLayoutModeCommand

Gets or sets the command to toggle the layout mode.

C#
public ICommand ToggleLayoutModeCommand { get; set; }

Viewport

Rect

Gets the current viewport rectangle of the document.

C#
public Rect Viewport { get; }

VisiblePagesCount

Gets the number of visible pages.

C#
public int VisiblePagesCount { get; }

VisiblePagesStartIndex

Gets the index of the first visible page.

C#
public int VisiblePagesStartIndex { get; }

ZoomInCommand

Gets or sets the command to zoom in the document.

C#
public ICommand ZoomInCommand { get; set; }

ZoomLevel

Gets the current zoom level of the document.

C#
public double ZoomLevel { get; }

ZoomOutCommand

Gets or sets the command to zoom out the document.

C#
public ICommand ZoomOutCommand { get; set; }

Methods

ChangeViewport(Rect)

Changes the Viewport property to the desired value.

C#
public void ChangeViewport(Rect viewport)
Parameters:viewportRect

The new value of the Viewport property.

NavigateToPage(int)

Navigates to the specified page index.

C#
public void NavigateToPage(int index)
Parameters:indexint

The zero-based index of the page to navigate to.

OnChildAdded(Element)

Called when a child element is added to the PDF viewer.

C#
protected override void OnChildAdded(Element child)
Parameters:childElement

The child element that was added.

OnChildRemoved(Element, int)

Called when a child element is removed from the PDF viewer.

C#
protected override void OnChildRemoved(Element child, int oldLogicalIndex)
Parameters:childElement

The child element that was removed.

oldLogicalIndexint

The old logical index of the child element.

OnPropertyChanged(string)

Called when a property value changes.

C#
protected override void OnPropertyChanged(string propertyName = null)
Parameters:propertyNamestring

The name of the property that changed.

ScrollIntoView(Rect)

Scrolls the control, so that the Rect parameter appears into the viewport. Zoom is performed if necessary. No change is performed if the Rect parameter is already into view.

C#
public void ScrollIntoView(Rect rect)
Parameters:rectRect

The Rect to scroll to.

ScrollIntoView(TextRange)

Scrolls the control, so that the TextRange parameter appears into the viewport. Zoom is performed if necessary. No change is performed if the TextRange parameter is already into view.

C#
public void ScrollIntoView(TextRange range)
Parameters:rangeTextRange

The TextRange to scroll to.

ZoomToLevel(double)

Zooms the document to the specified zoom level.

C#
public void ZoomToLevel(double zoomLevel)
Parameters:zoomLeveldouble

The zoom level to apply.

Events

LinkAnnotationTapped

Occurs when a link annotation is tapped within the PDF document.

C#
public event EventHandler<LinkAnnotationTappedEventArgs> LinkAnnotationTapped

PageElementsLoaded

An event that is raised after the model elements of a page were loaded. Use this event to alter the page content before it is rendered. This event is raised on a background thread.

C#
public event EventHandler<PageElementsLoadedEventArgs> PageElementsLoaded

SourceException

Occurs when an exception is raised during document loading or processing.

C#
public event EventHandler<SourceExceptionEventArgs> SourceException

SourcePasswordNeeded

EventHandler<PasswordNeededEventArgs>

An event that is raised during document import if a password is needed. This event may be raised on a non-UI thread. The password can be provided in the event args.

C#
public event EventHandler<PasswordNeededEventArgs> SourcePasswordNeeded
In this article
DefinitionConstructorsRadPdfViewer()FieldsBackgroundColorPropertyBusyIndicatorTemplatePropertyCloseSearchViewCommandPropertyDocumentPropertyDoubleTappedCommandPropertyFitToWidthCommandPropertyLayoutModePropertyMaxZoomLevelPropertyMinZoomLevelPropertyNavigateToNextPageCommandPropertyNavigateToNextSearchResultCommandPropertyNavigateToPageCommandPropertyNavigateToPreviousPageCommandPropertyNavigateToPreviousSearchResultCommandPropertyOpenSearchViewCommandPropertyPageSpacingPropertySearchSettingsPropertySelectionSettingsPropertySourceExceptionTemplatePropertySourcePropertyToggleLayoutModeCommandPropertyViewportPropertyVisiblePagesCountPropertyVisiblePagesStartIndexPropertyZoomInCommandPropertyZoomLevelPropertyZoomOutCommandPropertyPropertiesBackgroundColorBusyIndicatorTemplateCloseSearchViewCommandDocumentDoubleTappedCommandEnableHardwareAccelerationFitToWidthCommandLayoutModeMaxZoomLevelMinZoomLevelNavigateToNextPageCommandNavigateToNextSearchResultCommandNavigateToPageCommandNavigateToPreviousPageCommandNavigateToPreviousSearchResultCommandOpenSearchViewCommandPageSpacingSearchContentViewSearchSettingsSelectionSettingsSourceSourceExceptionTemplateToggleLayoutModeCommandViewportVisiblePagesCountVisiblePagesStartIndexZoomInCommandZoomLevelZoomOutCommandMethodsChangeViewport(Rect)NavigateToPage(int)OnChildAdded(Element)OnChildRemoved(Element, int)OnPropertyChanged(string)ScrollIntoView(Rect)ScrollIntoView(TextRange)ZoomToLevel(double)EventsLinkAnnotationTappedPageElementsLoadedSourceExceptionSourcePasswordNeeded
Not finding the help you need?
Contact Support