Class

RadPdfViewer

Initializes a new instance of the RadPdfViewer class.

Declaration

public RadPdfViewer()

Identifies the BackgroundColor property.

Declaration

public static readonly BindableProperty BackgroundColorProperty

Field Value

Identifies the BusyIndicatorTemplate property.

Declaration

public static readonly BindableProperty BusyIndicatorTemplateProperty

Field Value

Identifies the CloseSearchViewCommand property.

Declaration

public static readonly BindableProperty CloseSearchViewCommandProperty

Field Value

Identifies the Document property.

Declaration

public static readonly BindableProperty DocumentProperty

Field Value

Identifies the DoubleTappedCommand property.

Declaration

public static readonly BindableProperty DoubleTappedCommandProperty

Field Value

Identifies the FitToWidthCommand property.

Declaration

public static readonly BindableProperty FitToWidthCommandProperty

Field Value

Identifies the LayoutMode property.

Declaration

public static readonly BindableProperty LayoutModeProperty

Field Value

Identifies the MaxZoomLevel property.

Declaration

public static readonly BindableProperty MaxZoomLevelProperty

Field Value

Identifies the MinZoomLevel property.

Declaration

public static readonly BindableProperty MinZoomLevelProperty

Field Value

Identifies the NavigateToNextPageCommand property.

Declaration

public static readonly BindableProperty NavigateToNextPageCommandProperty

Field Value

Identifies the NavigateToNextSearchResultCommand property.

Declaration

public static readonly BindableProperty NavigateToNextSearchResultCommandProperty

Field Value

Identifies the NavigateToPageCommand property.

Declaration

public static readonly BindableProperty NavigateToPageCommandProperty

Field Value

Identifies the NavigateToPreviousPageCommand property.

Declaration

public static readonly BindableProperty NavigateToPreviousPageCommandProperty

Field Value

Identifies the NavigateToPreviousSearchResultCommand property.

Declaration

public static readonly BindableProperty NavigateToPreviousSearchResultCommandProperty

Field Value

Identifies the OpenSearchViewCommand property.

Declaration

public static readonly BindableProperty OpenSearchViewCommandProperty

Field Value

Identifies the PageSpacing property.

Declaration

public static readonly BindableProperty PageSpacingProperty

Field Value

Identifies the SearchSettings property.

Declaration

public static readonly BindableProperty SearchSettingsProperty

Field Value

Identifies the SelectionSettings property.

Declaration

public static readonly BindableProperty SelectionSettingsProperty

Field Value

Identifies the SourceExceptionTemplate property.

Declaration

public static readonly BindableProperty SourceExceptionTemplateProperty

Field Value

Identifies the Source property.

Declaration

public static readonly BindableProperty SourceProperty

Field Value

Identifies the ToggleLayoutModeCommand property.

Declaration

public static readonly BindableProperty ToggleLayoutModeCommandProperty

Field Value

Identifies the Viewport property.

Declaration

public static readonly BindableProperty ViewportProperty

Field Value

Identifies the VisiblePagesCount property.

Declaration

public static readonly BindableProperty VisiblePagesCountProperty

Field Value

Identifies the VisiblePagesStartIndex property.

Declaration

public static readonly BindableProperty VisiblePagesStartIndexProperty

Field Value

Identifies the ZoomInCommand property.

Declaration

public static readonly BindableProperty ZoomInCommandProperty

Field Value

Identifies the ZoomLevel property.

Declaration

public static readonly BindableProperty ZoomLevelProperty

Field Value

Identifies the ZoomOutCommand property.

Declaration

public static readonly BindableProperty ZoomOutCommandProperty

Field Value

Gets or sets the background color of the PDF viewer.

Declaration

public Color BackgroundColor { get; set; }

Property Value

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

Declaration

public DataTemplate BusyIndicatorTemplate { get; set; }

Property Value

Gets or sets the ICommand which closes the PdfViewerSearchContentView.

Declaration

public ICommand CloseSearchViewCommand { get; set; }

Property Value

Gets the currently loaded PDF document.

Declaration

public RadFixedDocument Document { get; }

Property Value

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.

Declaration

public ICommand DoubleTappedCommand { get; set; }

Property Value

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.

Declaration

public bool EnableHardwareAcceleration { get; set; }

Property Value

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

Declaration

public ICommand FitToWidthCommand { get; set; }

Property Value

Gets or sets the layout mode for displaying PDF pages.

Declaration

public LayoutMode LayoutMode { get; set; }

Property Value

Gets or sets the maximum zoom level allowed.

Declaration

public double MaxZoomLevel { get; set; }

Property Value

Gets or sets the minimum zoom level allowed.

Declaration

public double MinZoomLevel { get; set; }

Property Value

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

Declaration

public ICommand NavigateToNextPageCommand { get; set; }

Property Value

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

Declaration

public ICommand NavigateToNextSearchResultCommand { get; }

Property Value

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.

Declaration

public ICommand NavigateToPageCommand { get; set; }

Property Value

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

Declaration

public ICommand NavigateToPreviousPageCommand { get; set; }

Property Value

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

Declaration

public ICommand NavigateToPreviousSearchResultCommand { get; }

Property Value

Gets or sets the ICommand which opens the PdfViewerSearchContentView.

Declaration

public ICommand OpenSearchViewCommand { get; set; }

Property Value

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

Declaration

public double PageSpacing { get; set; }

Property Value

Gets the search content view for the PDF viewer.

Declaration

public PdfViewerSearchContentView SearchContentView { get; }

Property Value

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

Declaration

public PdfViewerSearchSettings SearchSettings { get; set; }

Property Value

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

Declaration

public PdfViewerSelectionSettings SelectionSettings { get; set; }

Property Value

Gets or sets the document source for the PDF viewer.

Declaration

public DocumentSource Source { get; set; }

Property Value

Gets or sets the template for displaying source exceptions.

Declaration

public DataTemplate SourceExceptionTemplate { get; set; }

Property Value

Gets or sets the command to toggle the layout mode.

Declaration

public ICommand ToggleLayoutModeCommand { get; set; }

Property Value

Gets the current viewport rectangle of the document.

Declaration

public Rect Viewport { get; }

Property Value

Gets the number of visible pages.

Declaration

public int VisiblePagesCount { get; }

Property Value

Gets the index of the first visible page.

Declaration

public int VisiblePagesStartIndex { get; }

Property Value

Gets or sets the command to zoom in the document.

Declaration

public ICommand ZoomInCommand { get; set; }

Property Value

Gets the current zoom level of the document.

Declaration

public double ZoomLevel { get; }

Property Value

Gets or sets the command to zoom out the document.

Declaration

public ICommand ZoomOutCommand { get; set; }

Property Value

Changes the Viewport property to the desired value.

Declaration

public void ChangeViewport(Rect viewport)

Parameters

Navigates to the specified page index.

Declaration

public void NavigateToPage(int index)

Parameters

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

Declaration

protected override void OnChildAdded(Element child)

Parameters

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

Declaration

protected override void OnChildRemoved(Element child, int oldLogicalIndex)

Parameters

Called when a property value changes.

Declaration

protected override void OnPropertyChanged(string propertyName = null)

Parameters

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.

Declaration

public void ScrollIntoView(Rect rect)

Parameters

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.

Declaration

public void ScrollIntoView(TextRange range)

Parameters

Zooms the document to the specified zoom level.

Declaration

public void ZoomToLevel(double zoomLevel)

Parameters

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

Declaration

public event EventHandler<LinkAnnotationTappedEventArgs> LinkAnnotationTapped

Event Value

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 Value

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

Declaration

public event EventHandler<SourceExceptionEventArgs> SourceException

Event Value

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 Value