1. Home
  2. API
  3. Broadside.Viewer.Maui
  4. PdfView

PdfView Class

Definition

Assembly Broadside.Viewer.Maui.dll
View source
Show inherited members (279)

A .NET MAUI control that shows a PDF document on the shared viewer core, drawn with SkiaSharp: tiles render through SkiaTileBackend off the UI thread and are composed on the GPU (Metal on iOS and Mac Catalyst, OpenGL ES on Android through SkiaSharp.Views.Maui.Controls.SKGLView, Direct3D on Windows) unless UseHardwareAcceleration is off (a CPU raster canvas).

public sealed class PdfView : ContentView, INotifyPropertyChanged, IDynamicResourceHandler, IElementDefinition, INameScope, IEffectControlProvider, IToolTipElement, IContextFlyoutElement, IHandlerDisconnectPolicies, IStyleSelectable, INavigationProxy, IAnimatable, IResourcesProvider, IStyleElement, IFlowDirectionController, IPropertyPropagationController, IVisualController, IWindowController, IConstrainedView, IStylable, IViewController, IVisualElementController, IElementController, IGestureController, IGestureRecognizers, IPropertyMapperView, IHotReloadableView, IReplaceableView, IControlsView, IControlsVisualElement, IControlsElement, ILayout, ILayoutController, IPaddingElement, IVisualTreeElement, IInputTransparentContainerElement, IControlTemplated, IClippedToBoundsElement, IContentView, IView, IElement, ITransform, IPadding, ICrossPlatformLayout, ISafeAreaView2, ISafeAreaElement, IViewerHost, IDisposable

Remarks

Touch, mouse, pen and wheel input go through one InputModel, so pan, fling, pinch and double-tap behave the same on every platform. Mouse drags over text select it (double click: word, triple: line); on touch a long press selects a word and handles extend it. Links and form fields go through the AnnotationLayer: links inside the document navigate, every other action (URIs, launches, scripts) is raised as ActionRequested and never performed. A tapped text or choice field opens a native editor over the widget; an edit redraws only the overlay tiles it touches. With UseBroadsideViewer(MauiAppBuilder) the view also takes keyboard input on desktops and hardware keyboards (arrows, Page Up/Down, Home/End, +/-, Tab between fields, Ctrl/Cmd+A and +C).

ISO 32000-2 §12.3.2 (destinations), §12.5.6.5 (link annotations), §12.7 (interactive forms), §14.8 and §14.11.2.

Tip: use kind:method, kind:property, kind:ctor. Press Esc to clear.

Constructors (1)

PdfView()Creates an empty view; set Source or Session to show a document.

Fields (6)

AllowAnnotationEditingPropertyThe AllowAnnotationEditing property.
LayoutOptionsPropertyThe LayoutOptions property.
SessionPropertyThe Session property: a document session the host opened and owns.
ShowAnnotationsPropertyThe ShowAnnotations property.
SourcePropertyThe Source property: a file path or an http(s) address of the document to show.
UseHardwareAccelerationPropertyThe UseHardwareAcceleration property.

Properties (12)

AccessibilityGets the accessibility bridge of the open document, or null.
AllowAnnotationEditingGets or sets whether markup annotations can be selected and dragged (default false; links and fields always work).
AnnotationsGets the annotation and link layer of the open document, or null (form values and annotation edits go through it).
CurrentSessionGets the open document's session (from Source or Session), or null.
LayoutOptionsGets or sets the page layout (continuous by default); changes apply at once, keeping the current page.
OptionsGets or sets the options for documents opened from Source; without a backend factory, tiles draw with SkiaTileBackend.
SelectionGets the text selection of the open document, or null.
SessionGets or sets a document session the host opened (and disposes); it takes precedence over Source.
ShowAnnotationsGets or sets whether annotations and form fields are drawn and interactive (default true).
SourceGets or sets the document to show: a file path, or an http(s) address read through range requests.
StateGets what the view shows.
UseHardwareAccelerationGets or sets whether the view composes on the GPU (SkiaSharp.Views.Maui.Controls.SKGLView, default) or on the CPU (SkiaSharp.Views.Maui.Controls.SKCanvasView).

Methods (11)

CaptureFrameAsync(CancellationToken)Captures the next frame the canvas draws (read back from the GPU surface when hardware accelerated) as PNG bytes.
CopySelectionAsync()Copies the selected text to the clipboard.
Dispose()Closes the document and releases the tiles and GPU images.
GoToPage(Int32)Shows a page (zero-based).
NextPage()Shows the next page or spread.
OnHandlerChanged()
OnSizeAllocated(Double, Double)
PreviousPage()Shows the previous page or spread.
ScrollBy(Double, Double)Scrolls the view by a distance in device-independent units, as a wheel or trackpad scroll does (no animation).
ZoomBy(Double)Zooms by a factor around the view's centre.
ZoomTo(ZoomMode)Zooms to a fit mode or the actual size, animated.

Events (3)

ActionRequestedRaised for every action a link, widget or annotation asks for. Destinations inside the document have already been followed when this is raised; URIs, launches, named actions and scripts are never performed by the view.
ErrorRaised when opening the document, loading a page's text or links, or drawing fails.
StateChangedRaised when the page, page count, zoom or loading state changes.