Documentation

Class RadPdfViewer

Displays PDF documents. Works with RadPdfViewerToolbar to expose interactions like zoom in/out, search, navigate in pages and search results.

Inheritance

System.Object

RadLayout

RadPdfViewer

Inherited Members

RadLayout.CreateLayoutManager()

Namespace: Telerik.Maui.Controls

Assembly: Telerik.Maui.Controls.dll

Syntax

public class RadPdfViewer : RadLayout

Constructors

RadPdfViewer()

Declaration

public RadPdfViewer()

Fields

BackgroundColorProperty

Declaration

public static readonly BindableProperty BackgroundColorProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

BusyIndicatorTemplateProperty

Declaration

public static readonly BindableProperty BusyIndicatorTemplateProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

CloseSearchViewCommandProperty

Declaration

public static readonly BindableProperty CloseSearchViewCommandProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

DocumentProperty

Declaration

public static readonly BindableProperty DocumentProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

DoubleTappedCommandProperty

Declaration

public static readonly BindableProperty DoubleTappedCommandProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

FitToWidthCommandProperty

Declaration

public static readonly BindableProperty FitToWidthCommandProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

LayoutModeProperty

Declaration

public static readonly BindableProperty LayoutModeProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

MaxZoomLevelProperty

Declaration

public static readonly BindableProperty MaxZoomLevelProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

MinZoomLevelProperty

Declaration

public static readonly BindableProperty MinZoomLevelProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

NavigateToNextPageCommandProperty

Declaration

public static readonly BindableProperty NavigateToNextPageCommandProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

NavigateToNextSearchResultCommandProperty

Identifies the NavigateToNextSearchResultCommand property.

Declaration

public static readonly BindableProperty NavigateToNextSearchResultCommandProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

NavigateToPageCommandProperty

Declaration

public static readonly BindableProperty NavigateToPageCommandProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

NavigateToPreviousPageCommandProperty

Declaration

public static readonly BindableProperty NavigateToPreviousPageCommandProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

NavigateToPreviousSearchResultCommandProperty

Identifies the NavigateToPreviousSearchResultCommand property.

Declaration

public static readonly BindableProperty NavigateToPreviousSearchResultCommandProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

OpenSearchViewCommandProperty

Declaration

public static readonly BindableProperty OpenSearchViewCommandProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

PageSpacingProperty

Declaration

public static readonly BindableProperty PageSpacingProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

SearchSettingsProperty

Declaration

public static readonly BindableProperty SearchSettingsProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

SelectionSettingsProperty

Declaration

public static readonly BindableProperty SelectionSettingsProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

SourceExceptionTemplateProperty

Declaration

public static readonly BindableProperty SourceExceptionTemplateProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

SourceProperty

Declaration

public static readonly BindableProperty SourceProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

ToggleLayoutModeCommandProperty

Declaration

public static readonly BindableProperty ToggleLayoutModeCommandProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

ViewportProperty

Declaration

public static readonly BindableProperty ViewportProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

VisiblePagesCountProperty

Declaration

public static readonly BindableProperty VisiblePagesCountProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

VisiblePagesStartIndexProperty

Declaration

public static readonly BindableProperty VisiblePagesStartIndexProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

ZoomInCommandProperty

Declaration

public static readonly BindableProperty ZoomInCommandProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

ZoomLevelProperty

Declaration

public static readonly BindableProperty ZoomLevelProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

ZoomOutCommandProperty

Declaration

public static readonly BindableProperty ZoomOutCommandProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

Properties

BackgroundColor

Declaration

public Color BackgroundColor { get; set; }

Property Value

Microsoft.Maui.Graphics.Color

BusyIndicatorTemplate

Declaration

public DataTemplate BusyIndicatorTemplate { get; set; }

Property Value

Microsoft.Maui.Controls.DataTemplate

CloseSearchViewCommand

Gets or sets the System.Windows.Input.ICommand which closes the PdfViewerSearchContentView.

Declaration

public ICommand CloseSearchViewCommand { get; set; }

Property Value

System.Windows.Input.ICommand

Document

Declaration

public RadFixedDocument Document { get; }

Property Value

Telerik.Windows.Documents.Fixed.Model.RadFixedDocument

DoubleTappedCommand

Declaration

public ICommand DoubleTappedCommand { get; set; }

Property Value

System.Windows.Input.ICommand

EnableHardwareAcceleration

Declaration

public bool EnableHardwareAcceleration { get; set; }

Property Value

System.Boolean

FitToWidthCommand

Declaration

public ICommand FitToWidthCommand { get; set; }

Property Value

System.Windows.Input.ICommand

LayoutMode

Declaration

public LayoutMode LayoutMode { get; set; }

Property Value

LayoutMode

MaxZoomLevel

Declaration

public double MaxZoomLevel { get; set; }

Property Value

System.Double

MinZoomLevel

Declaration

public double MinZoomLevel { get; set; }

Property Value

System.Double

NavigateToNextPageCommand

Declaration

public ICommand NavigateToNextPageCommand { get; set; }

Property Value

System.Windows.Input.ICommand

NavigateToNextSearchResultCommand

Gets the System.Windows.Input.ICommand executed when navigating to the next search result.

Declaration

public ICommand NavigateToNextSearchResultCommand { get; }

Property Value

System.Windows.Input.ICommand

NavigateToPageCommand

Declaration

public ICommand NavigateToPageCommand { get; set; }

Property Value

System.Windows.Input.ICommand

NavigateToPreviousPageCommand

Declaration

public ICommand NavigateToPreviousPageCommand { get; set; }

Property Value

System.Windows.Input.ICommand

NavigateToPreviousSearchResultCommand

Gets the System.Windows.Input.ICommand executed when navigating to the previous search result.

Declaration

public ICommand NavigateToPreviousSearchResultCommand { get; }

Property Value

System.Windows.Input.ICommand

OpenSearchViewCommand

Declaration

public ICommand OpenSearchViewCommand { get; set; }

Property Value

System.Windows.Input.ICommand

PageSpacing

Declaration

public double PageSpacing { get; set; }

Property Value

System.Double

SearchContentView

Declaration

public PdfViewerSearchContentView SearchContentView { get; }

Property Value

PdfViewerSearchContentView

SearchSettings

Declaration

public PdfViewerSearchSettings SearchSettings { get; set; }

Property Value

PdfViewerSearchSettings

SelectionSettings

Declaration

public PdfViewerSelectionSettings SelectionSettings { get; set; }

Property Value

PdfViewerSelectionSettings

Source

Declaration

public DocumentSource Source { get; set; }

Property Value

DocumentSource

SourceExceptionTemplate

Declaration

public DataTemplate SourceExceptionTemplate { get; set; }

Property Value

Microsoft.Maui.Controls.DataTemplate

ToggleLayoutModeCommand

Declaration

public ICommand ToggleLayoutModeCommand { get; set; }

Property Value

System.Windows.Input.ICommand

Viewport

Declaration

public Rect Viewport { get; }

Property Value

Microsoft.Maui.Graphics.Rect

VisiblePagesCount

Declaration

public int VisiblePagesCount { get; }

Property Value

System.Int32

VisiblePagesStartIndex

Declaration

public int VisiblePagesStartIndex { get; }

Property Value

System.Int32

ZoomInCommand

Declaration

public ICommand ZoomInCommand { get; set; }

Property Value

System.Windows.Input.ICommand

ZoomLevel

Declaration

public double ZoomLevel { get; }

Property Value

System.Double

ZoomOutCommand

Declaration

public ICommand ZoomOutCommand { get; set; }

Property Value

System.Windows.Input.ICommand

Methods

ChangeViewport(Rect)

Changes the Viewport property to the desired value.

Declaration

public void ChangeViewport(Rect viewport)

Parameters

Microsoft.Maui.Graphics.Rect viewport The new value of the Viewport property.

NavigateToPage(Int32)

Declaration

public void NavigateToPage(int index)

Parameters

System.Int32 index

OnChildAdded(Element)

Declaration

protected override void OnChildAdded(Element child)

Parameters

Microsoft.Maui.Controls.Element child

OnChildRemoved(Element, Int32)

Declaration

protected override void OnChildRemoved(Element child, int oldLogicalIndex)

Parameters

Microsoft.Maui.Controls.Element child
System.Int32 oldLogicalIndex

OnPropertyChanged(String)

Declaration

protected override void OnPropertyChanged(string propertyName = null)

Parameters

System.String propertyName

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

Declaration

public void ScrollIntoView(Rect rect)

Parameters

Microsoft.Maui.Graphics.Rect rect The Microsoft.Maui.Graphics.Rect to scroll to.

ScrollIntoView(TextRange)

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

Declaration

public void ScrollIntoView(TextRange range)

Parameters

Telerik.Windows.Documents.Fixed.Text.TextRange range The Telerik.Windows.Documents.Fixed.Text.TextRange to scroll to.

ZoomToLevel(Double)

Declaration

public void ZoomToLevel(double zoomLevel)

Parameters

System.Double zoomLevel

Events

LinkAnnotationTapped

Declaration

public event EventHandler<LinkAnnotationTappedEventArgs> LinkAnnotationTapped

Event Type

System.EventHandler<LinkAnnotationTappedEventArgs>

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.

Declaration

public event EventHandler<PageElementsLoadedEventArgs> PageElementsLoaded

Event Type

System.EventHandler<PageElementsLoadedEventArgs>

SourceException

Declaration

public event EventHandler<SourceExceptionEventArgs> SourceException

Event Type

System.EventHandler<SourceExceptionEventArgs>

SourcePasswordNeeded

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.

Declaration

public event EventHandler<PasswordNeededEventArgs> SourcePasswordNeeded

Event Type

System.EventHandler<Telerik.Windows.Documents.Fixed.FormatProviders.Pdf.Import.PasswordNeededEventArgs>

Extension Methods

AndroidTypeConversionExtensions.ToJavaObject(Object)