Class SfPdfViewerControl

Represents a control that displays PDF documents.

Inheritance
System.Object
SfPdfViewerControl
Namespace: Syncfusion.Windows.PdfViewer
Assembly: Syncfusion.SfPdfViewer.UWP.dll
Syntax
public class SfPdfViewerControl : Control

Constructors

SfPdfViewerControl()

Creates a new instance of the SfPdfViewerControl class.

Declaration
public SfPdfViewerControl()

Fields

ClearTextSelectionCommandParameterProperty

Backing store for the ClearTextSelectionCommandParameter property.

Declaration
public static readonly DependencyProperty ClearTextSelectionCommandParameterProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

ClearTextSelectionCommandProperty

Backing store for the ClearTextSelectionCommand property.

Declaration
public static readonly DependencyProperty ClearTextSelectionCommandProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

DecreaseZoomCommandParameterProperty

Backing store for the DecreaseZoomCommandParameter property.

Declaration
public static readonly DependencyProperty DecreaseZoomCommandParameterProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

DecreaseZoomCommandProperty

Backing store for the DecreaseZoomCommand property.

Declaration
public static readonly DependencyProperty DecreaseZoomCommandProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

FirstPageCommandParameterProperty

Backing store for the FirstPageCommandParameter property.

Declaration
public static readonly DependencyProperty FirstPageCommandParameterProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

FirstPageCommandProperty

Backing store for the FirstPageCommand property.

Declaration
public static readonly DependencyProperty FirstPageCommandProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

FreeTextCalloutAnnotationCommandProperty

Backing store for the FreeTextCalloutAnnotationCommand property.

Declaration
public static readonly DependencyProperty FreeTextCalloutAnnotationCommandProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

GoToPageCommandParameterProperty

Backing store for the GoToPageCommandParameter property.

Declaration
public static readonly DependencyProperty GoToPageCommandParameterProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

GoToPageCommandProperty

Backing store for the GoToPageCommand property.

Declaration
public static readonly DependencyProperty GoToPageCommandProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

IncreaseZoomCommandParameterProperty

Backing store for the IncreaseZoomCommandParameter property.

Declaration
public static readonly DependencyProperty IncreaseZoomCommandParameterProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

IncreaseZoomCommandProperty

Backing store for the IncreaseZoomCommand property.

Declaration
public static readonly DependencyProperty IncreaseZoomCommandProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

IsDocumentEditedProperty

Declaration
public static readonly DependencyProperty IsDocumentEditedProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

IsTextSelectionEnabledProperty

Backing store for the IsTextSelectionEnabled property.

Declaration
public static readonly DependencyProperty IsTextSelectionEnabledProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

ItemsSourceProperty

Backing store for the ItemsSource property.

Declaration
public static readonly DependencyProperty ItemsSourceProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

LastPageCommandParameterProperty

Backing store for the LastPageCommandParameter property.

Declaration
public static readonly DependencyProperty LastPageCommandParameterProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

LastPageCommandProperty

Backing store for the LastPageCommand property.

Declaration
public static readonly DependencyProperty LastPageCommandProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

MinimumZoomPercentageProperty

DependencyProperty to track the value of MinimumZoomPercentage property

Declaration
public static readonly DependencyProperty MinimumZoomPercentageProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

NextPageCommandParameterProperty

Backing store for the NextPageCommandParameter property.

Declaration
public static readonly DependencyProperty NextPageCommandParameterProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

NextPageCommandProperty

Backing store for the NextPageCommand property.

Declaration
public static readonly DependencyProperty NextPageCommandProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

PageCountProperty

Backing store for the PageCount proeprty.

Declaration
public static readonly DependencyProperty PageCountProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

PageNumberProperty

Backing store for the PageNumber property.

Declaration
public static readonly DependencyProperty PageNumberProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

PageNumberViewModeProperty

Backing store for the PageNumberViewMode property.

Declaration
public static readonly DependencyProperty PageNumberViewModeProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

PdfProgressRingProperty

Backing store for the PdfProgressRing property.

Declaration
public static readonly DependencyProperty PdfProgressRingProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

PreviousPageCommandParameterProperty

Backing store for the PreviousPageCommandParameter property.

Declaration
public static readonly DependencyProperty PreviousPageCommandParameterProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

PreviousPageCommandProperty

Backing store for the PreviousPageCommand property.

Declaration
public static readonly DependencyProperty PreviousPageCommandProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

PrintCommandParameterProperty

Backing store for the PrintCommandParameter property.

Declaration
public static readonly DependencyProperty PrintCommandParameterProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

PrintCommandProperty

Backing store for the PrintCommand property.

Declaration
public static readonly DependencyProperty PrintCommandProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

SearchNextCommandParameterProperty

Backing store for the SearchNextCommandParameter property.

Declaration
public static readonly DependencyProperty SearchNextCommandParameterProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

SearchNextCommandProperty

Backing store for the SearchNextCommand property.

Declaration
public static readonly DependencyProperty SearchNextCommandProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

SearchPreviousCommandParameterProperty

Declaration
public static readonly DependencyProperty SearchPreviousCommandParameterProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

SearchPreviousCommandProperty

Declaration
public static readonly DependencyProperty SearchPreviousCommandProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

ShowPageNumberProperty

Backing store for the ShowPageNumber property.

Declaration
public static readonly DependencyProperty ShowPageNumberProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

SwitchToThumbNailModeCommandProperty

Backing store for the SwitchToThumbnailModeCommand property.

Declaration
public static readonly DependencyProperty SwitchToThumbNailModeCommandProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

SwitchToThumnailModeCommandParameterProperty

Backing store for the SwitchToThumbnailModeCommandParameter property.

Declaration
public static readonly DependencyProperty SwitchToThumnailModeCommandParameterProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

ViewModeCommandParameterProperty

Backing store for the ViewModeCommandParameter property.

Declaration
public static readonly DependencyProperty ViewModeCommandParameterProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

ViewModeCommandProperty

Backing store for the ViewModeCommand property.

Declaration
public static readonly DependencyProperty ViewModeCommandProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

ViewModeProperty

Backing store for the ViewMode property.

Declaration
public static readonly DependencyProperty ViewModeProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

VisibilityParameterPtoperty

Backing store for the VisibilityParameter property.

Declaration
public static readonly DependencyProperty VisibilityParameterPtoperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

VisibilityProperty

Backing store for the Visibility property.

Declaration
public static readonly DependencyProperty VisibilityProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

ZoomProperty

Backing store for the Zoom property.

Declaration
public static readonly DependencyProperty ZoomProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

Properties

AllowHyperlinkNavigation

Enable or Disable the hyperlink navigation.

Declaration
public bool AllowHyperlinkNavigation { get; set; }
Property Value
Type Description
System.Boolean

The default value is true.

AnnotationCollection

Gets the collection of annotations present in the PDF.

Declaration
public ObservableCollection<IAnnotation> AnnotationCollection { get; }
Property Value
Type Description
System.Collections.ObjectModel.ObservableCollection<IAnnotation>

AnnotationSettings

Gets or sets the appearance of the annotation.

Declaration
public AnnotationSettings AnnotationSettings { get; set; }
Property Value
Type Description
AnnotationSettings

AnnotationVisibility

Gets or sets the visibility of annotations.

Declaration
public Visibility AnnotationVisibility { get; set; }
Property Value
Type Description
Windows.UI.Xaml.Visibility

ClearAllAnnotationsCommand

The command to clear all the annotations added to the PDF Viewer.

Declaration
public ICommand ClearAllAnnotationsCommand { get; set; }
Property Value
Type Description
System.Windows.Input.ICommand

ClearTextSelectionCommand

The command to clear the selection of text.

Declaration
public ICommand ClearTextSelectionCommand { get; set; }
Property Value
Type Description
System.Windows.Input.ICommand

ClearTextSelectionCommandParameter

The parameter for the ClearTextSelectionCommand.

Declaration
public object ClearTextSelectionCommandParameter { get; set; }
Property Value
Type Description
System.Object

DecreaseZoomCommand

The command that decreases the zoom level of the PDF.

Declaration
public ICommand DecreaseZoomCommand { get; set; }
Property Value
Type Description
System.Windows.Input.ICommand

DecreaseZoomCommandParameter

The parameter to the DecreaseZoomCommand.

Declaration
public object DecreaseZoomCommandParameter { get; set; }
Property Value
Type Description
System.Object

DocumentStream

Gets or sets the PDF stream.

Declaration
public Stream DocumentStream { get; set; }
Property Value
Type Description
System.IO.Stream

EllipseAnnotationCommand

Defines Command for EllipseAnnotation

Declaration
public ICommand EllipseAnnotationCommand { get; set; }
Property Value
Type Description
System.Windows.Input.ICommand

EllipseAnnotationSettings

Get and Set the Ellipse annotation settings

Declaration
public PdfViewerEllipseAnnotationSettings EllipseAnnotationSettings { get; set; }
Property Value
Type Description
PdfViewerEllipseAnnotationSettings

EnableContextMenu

Gets or sets the Boolean value to enable and disable the context menu in SfPdfViewer.

Declaration
public bool EnableContextMenu { get; set; }
Property Value
Type Description
System.Boolean

EnableNonTextSelectionAlert

Gets or sets the boolean value that determines whether an alert dialog should be displayed while performing text markup or text selection on a page with no text.

Declaration
public bool EnableNonTextSelectionAlert { get; set; }
Property Value
Type Description
System.Boolean

FirstPageCommand

The command to navigate to the first page of the PDF.

Declaration
public ICommand FirstPageCommand { get; set; }
Property Value
Type Description
System.Windows.Input.ICommand

FirstPageCommandParameter

The parameter for the FirstPageCommand.

Declaration
public object FirstPageCommandParameter { get; set; }
Property Value
Type Description
System.Object

FreeTextAnnotationCommand

Command to add freetext annotation

Declaration
public ICommand FreeTextAnnotationCommand { get; set; }
Property Value
Type Description
System.Windows.Input.ICommand

FreeTextAnnotationSettings

Gets or sets the settings for freetext annotations

Declaration
public PdfViewerFreeTextAnnotationSettings FreeTextAnnotationSettings { get; set; }
Property Value
Type Description
PdfViewerFreeTextAnnotationSettings

FreeTextCalloutAnnotationCommand

Command to include freetext callout annotation

Declaration
public ICommand FreeTextCalloutAnnotationCommand { get; set; }
Property Value
Type Description
System.Windows.Input.ICommand

FreeTextCalloutAnnotationSettings

Gets or sets the settings for freetext callout annotations

Declaration
public PdfViewerFreeTextCalloutAnnotationSettings FreeTextCalloutAnnotationSettings { get; set; }
Property Value
Type Description
PdfViewerFreeTextCalloutAnnotationSettings

GoToPageCommand

The command to navigate to a given page number.

Declaration
public ICommand GoToPageCommand { get; set; }
Property Value
Type Description
System.Windows.Input.ICommand

GoToPageCommandParameter

The parameter to the GoToPageCommand.

Declaration
public object GoToPageCommandParameter { get; set; }
Property Value
Type Description
System.Object

HighlightAnnotationCommand

Defines Command for Highlight annotation

Declaration
public ICommand HighlightAnnotationCommand { get; set; }
Property Value
Type Description
System.Windows.Input.ICommand

HighlightAnnotationSettings

Get and Set the highlight annotation settings

Declaration
public PdfViewerHighlightAnnotationSettings HighlightAnnotationSettings { get; set; }
Property Value
Type Description
PdfViewerHighlightAnnotationSettings

HorizontalOffset

Gets the Horizontal offset of the PDF Viewer

Declaration
public float HorizontalOffset { get; }
Property Value
Type Description
System.Single

HorizontalScrollBarVisibility

Gets or sets a value that indicates whether a horizontal ScrollBar should be displayed.

Declaration
public ScrollBarVisibility HorizontalScrollBarVisibility { get; set; }
Property Value
Type Description
Windows.UI.Xaml.Controls.ScrollBarVisibility

IncreaseZoomCommand

The command to increase the zoom level of the PDF.

Declaration
public ICommand IncreaseZoomCommand { get; set; }
Property Value
Type Description
System.Windows.Input.ICommand

IncreaseZoomCommandParameter

The parameter to the IncreaseZoomCommand.

Declaration
public object IncreaseZoomCommandParameter { get; set; }
Property Value
Type Description
System.Object

InkAnnotationCommand

Defines Command for ink annotation

Declaration
public ICommand InkAnnotationCommand { get; set; }
Property Value
Type Description
System.Windows.Input.ICommand

InkAnnotationSettings

Get and Set the ink annotation settings

Declaration
public PdfViewerInkAnnotationSettings InkAnnotationSettings { get; set; }
Property Value
Type Description
PdfViewerInkAnnotationSettings

IsDocumentEdited

Gets the value that indicates whether the document is edited.

Declaration
public bool IsDocumentEdited { get; }
Property Value
Type Description
System.Boolean

true if document is edited; otherwise, false.The default value is false.
Remarks

This property will be 'true' when any annotations or form fields values are added or changed. It will be reset to 'false', when the PDF is saved. It will again be set to 'true', if there are further changes made after saving. The undo and redo operations that change the annotations or form fields from their respective states at the time of saving will also set this property to 'true'.

IsTextSearchEnabled

Enables or Disables the Textsearch feature

Declaration
public bool IsTextSearchEnabled { get; set; }
Property Value
Type Description
System.Boolean

IsTextSelectionEnabled

Gets or sets a value that indicates whether text selection is enabled.

Declaration
public bool IsTextSelectionEnabled { get; set; }
Property Value
Type Description
System.Boolean

IsThumbnailViewEnabled

Gets or sets a value that indicates whether the thumbnail view mode is enabled.

Declaration
public bool IsThumbnailViewEnabled { get; set; }
Property Value
Type Description
System.Boolean

ItemsSource

Gets or sets the stream of the PDF loaded in the SfPdfViewerControl.

Declaration
public object ItemsSource { get; set; }
Property Value
Type Description
System.Object

LastPageCommand

The command to navigate to the last page of the PDF.

Declaration
public ICommand LastPageCommand { get; set; }
Property Value
Type Description
System.Windows.Input.ICommand

LastPageCommandParameter

The parameter to the LastPageCommand.

Declaration
public object LastPageCommandParameter { get; set; }
Property Value
Type Description
System.Object

LineAnnotationCommand

Defines Command for LineAnnotation

Declaration
public ICommand LineAnnotationCommand { get; set; }
Property Value
Type Description
System.Windows.Input.ICommand

LineAnnotationSettings

Get and Set the Line annotation settings

Declaration
public PdfViewerLineAnnotationSettings LineAnnotationSettings { get; set; }
Property Value
Type Description
PdfViewerLineAnnotationSettings

LoadedDocument

Gets the LoadedDocument of SfPdfViewerControl

Declaration
public PdfLoadedDocument LoadedDocument { get; }
Property Value
Type Description
PdfLoadedDocument

MinimumZoomPercentage

Gets or sets the minimum zoom percentage of SfPdfViewerControl.The accepted range is from 10% to 100%. Values less than 10% will be taken as 10%. Likewise values greater than 100% will be taken as 100%. Default value is the zoom percentage at which a single page completely fits the view port of PdfViewer. This fit-page zoom percentage is computed at runtime.

Declaration
public int MinimumZoomPercentage { get; set; }
Property Value
Type Description
System.Int32

NextPageCommand

The command to navigate to the next page of the PDF.

Declaration
public ICommand NextPageCommand { get; set; }
Property Value
Type Description
System.Windows.Input.ICommand

NextPageCommandParameter

The parameter to the NextPageCommand.

Declaration
public object NextPageCommandParameter { get; set; }
Property Value
Type Description
System.Object

PageCount

Gets the total page count

Declaration
public int PageCount { get; }
Property Value
Type Description
System.Int32

PageGap

Gets the gap between two pages in Integer.

Declaration
public int PageGap { get; }
Property Value
Type Description
System.Int32

PageNumber

Gets or sets the current page number.

Declaration
public int PageNumber { get; set; }
Property Value
Type Description
System.Int32

PageNumberViewMode

Get and Set the visibility mode of Page number displayed in SfPdfViewerControl

Declaration
public PageNumberViewMode PageNumberViewMode { get; set; }
Property Value
Type Description
PageNumberViewMode

PageOffsetCollection

Gets the collection of the page numbers along with the offset where the page ends.

Declaration
public Dictionary<int, double> PageOffsetCollection { get; }
Property Value
Type Description
System.Collections.Generic.Dictionary<System.Int32, System.Double>

PageView

Gets or sets the page view mode of the SfPdfViewerControl.

Declaration
public PdfViewerPageView PageView { get; set; }
Property Value
Type Description
PdfViewerPageView

PdfProgressRing

Gets or sets the progress ring that appears until the PDF is fully loaded.

Declaration
public ProgressRing PdfProgressRing { get; set; }
Property Value
Type Description
Windows.UI.Xaml.Controls.ProgressRing

PopupAnnotationCommand

Defines Command for PopupAnnotation annotation

Declaration
public ICommand PopupAnnotationCommand { get; set; }
Property Value
Type Description
System.Windows.Input.ICommand

PopupAnnotationSettings

Get and Set the Ellipse annotation settings

Declaration
public PdfViewerPopupAnnotationSettings PopupAnnotationSettings { get; set; }
Property Value
Type Description
PdfViewerPopupAnnotationSettings

PreviousPageCommand

The command to navigate to the previous page of the PDF.

Declaration
public ICommand PreviousPageCommand { get; set; }
Property Value
Type Description
System.Windows.Input.ICommand

PreviousPageCommandParameter

The parameter to the PreviousPageCommand.

Declaration
public object PreviousPageCommandParameter { get; set; }
Property Value
Type Description
System.Object

PrintCommand

The command to print the PDF.

Declaration
public ICommand PrintCommand { get; set; }
Property Value
Type Description
System.Windows.Input.ICommand

PrintCommandParameter

The parameter to the PrintCommand

Declaration
public object PrintCommandParameter { get; set; }
Property Value
Type Description
System.Object

PrinterSettings

Get or Sets the printer settings of the printer

Declaration
public PrinterSettings PrinterSettings { get; set; }
Property Value
Type Description
PrinterSettings

RectangleAnnotationCommand

Defines Command for RectangleAnnotation

Declaration
public ICommand RectangleAnnotationCommand { get; set; }
Property Value
Type Description
System.Windows.Input.ICommand

RectangleAnnotationSettings

Get and Set the Rectangle annotation settings

Declaration
public PdfViewerRectangleAnnotationSettings RectangleAnnotationSettings { get; set; }
Property Value
Type Description
PdfViewerRectangleAnnotationSettings

RedoCommand

Defines Command for Redo the changes

Declaration
public RedoCommand RedoCommand { get; set; }
Property Value
Type Description
RedoCommand

Renderer

Gets or sets the class instance that implements IPdfRenderer and provides the page rendering mechanism using third-party PDF renderers.

Declaration
public IPdfRenderer Renderer { get; set; }
Property Value
Type Description
IPdfRenderer

ResetAnnotationModeCommand

Defines command for resetting all the annotation modes

Declaration
public ICommand ResetAnnotationModeCommand { get; set; }
Property Value
Type Description
System.Windows.Input.ICommand

SearchNextCommand

The command to search the next instance of the text.

Declaration
public ICommand SearchNextCommand { get; set; }
Property Value
Type Description
System.Windows.Input.ICommand

SearchNextCommandParameter

The parameter to the SearchNextCommand.

Declaration
public object SearchNextCommandParameter { get; set; }
Property Value
Type Description
System.Object

SearchPreviousCommand

The command to search the previous instance of the text.

Declaration
public ICommand SearchPreviousCommand { get; set; }
Property Value
Type Description
System.Windows.Input.ICommand

SearchPreviousCommandParameter

The parameter to the SearchPreviousCommand.

Declaration
public object SearchPreviousCommandParameter { get; set; }
Property Value
Type Description
System.Object

ShowPageNumber

Gets or sets a value that indicates whether the page number should be displayed at the corner of each page.

Declaration
public bool ShowPageNumber { get; set; }
Property Value
Type Description
System.Boolean

SinglePageViewCommand

Defines Command for SinglePageFlipView

Declaration
public ICommand SinglePageViewCommand { get; set; }
Property Value
Type Description
System.Windows.Input.ICommand

StrikeoutAnnotationCommand

Defines Command for Strikeout annotation

Declaration
public ICommand StrikeoutAnnotationCommand { get; set; }
Property Value
Type Description
System.Windows.Input.ICommand

StrikethroughAnnotationSettings

Get and Set the strikethrough annotation settings

Declaration
public PdfViewerStrikethroughAnnotationSettings StrikethroughAnnotationSettings { get; set; }
Property Value
Type Description
PdfViewerStrikethroughAnnotationSettings

SwitchToThumbnailModeCommand

The command to switch to the thumbnail page view mode.

Declaration
public ICommand SwitchToThumbnailModeCommand { get; set; }
Property Value
Type Description
System.Windows.Input.ICommand

SwitchToThumbnailModeCommandParameter

The parameter to the SwitchToThumbnailModeCommand.

Declaration
public object SwitchToThumbnailModeCommandParameter { get; set; }
Property Value
Type Description
System.Object

TextSearchSettings

The class that provides settings for text search

Declaration
public TextSearchSettings TextSearchSettings { get; set; }
Property Value
Type Description
TextSearchSettings

TextSelectionMenu

Gets or sets a value of text selection menu in SfPdfViewerControl.

Declaration
public TextSelectionMenu TextSelectionMenu { get; set; }
Property Value
Type Description
TextSelectionMenu

TextSelectionSettings

The class that provides settings for text selection

Declaration
public TextSelectionSettings TextSelectionSettings { get; set; }
Property Value
Type Description
TextSelectionSettings

UnderlineAnnotationCommand

Defines Command for Underline annotation

Declaration
public ICommand UnderlineAnnotationCommand { get; set; }
Property Value
Type Description
System.Windows.Input.ICommand

UnderlineAnnotationSettings

Get and Set the underline annotation settings

Declaration
public PdfViewerUnderlineAnnotationSettings UnderlineAnnotationSettings { get; set; }
Property Value
Type Description
PdfViewerUnderlineAnnotationSettings

UndoCommand

Defines Command for Undo the changes

Declaration
public UndoCommand UndoCommand { get; set; }
Property Value
Type Description
UndoCommand

VerticalOffset

Gets the Vertical Offset of the PDF Viewer

Declaration
public float VerticalOffset { get; }
Property Value
Type Description
System.Single

VerticalScrollBarVisibility

Gets or sets a value that indicates whether a vertical ScrollBar should be displayed.

Declaration
public ScrollBarVisibility VerticalScrollBarVisibility { get; set; }
Property Value
Type Description
Windows.UI.Xaml.Controls.ScrollBarVisibility

ViewMode

Gets or sets the page view mode of the SfPdfViewerControl.

Declaration
public PageViewMode ViewMode { get; set; }
Property Value
Type Description
PageViewMode

ViewModeCommand

The command to the set the page view mode of the SfPdfViewerControl.

Declaration
public ICommand ViewModeCommand { get; set; }
Property Value
Type Description
System.Windows.Input.ICommand

ViewModeCommandParameter

The parameter to the ViewModeCommand.

Declaration
public object ViewModeCommandParameter { get; set; }
Property Value
Type Description
System.Object

Visibility

Gets or sets a value that indicates whether the SfPdfViewerControl should be visible.

Declaration
public Visibility Visibility { get; set; }
Property Value
Type Description
Windows.UI.Xaml.Visibility

VisibilityCommand

The command to set the visibility of the SfPdfViewerControl.

Declaration
public Visibility VisibilityCommand { get; set; }
Property Value
Type Description
Windows.UI.Xaml.Visibility

VisibilityParameter

The parameter to the VisibilityCommand.

Declaration
public object VisibilityParameter { get; set; }
Property Value
Type Description
System.Object

Zoom

Gets the current zoom percentage.

Declaration
public int Zoom { get; }
Property Value
Type Description
System.Int32

Methods

add_TextFound(SfPdfViewerControl.TextFoundEventHandler)

Declaration
public void add_TextFound(SfPdfViewerControl.TextFoundEventHandler value)
Parameters
Type Name Description
SfPdfViewerControl.TextFoundEventHandler value

add_TextSearchCompleted(SfPdfViewerControl.TextSearchCompletedEventHandler)

Declaration
public void add_TextSearchCompleted(SfPdfViewerControl.TextSearchCompletedEventHandler value)
Parameters
Type Name Description
SfPdfViewerControl.TextSearchCompletedEventHandler value

add_TextSearchInitiated(SfPdfViewerControl.TextSearchInitiatedEventHandler)

Declaration
public void add_TextSearchInitiated(SfPdfViewerControl.TextSearchInitiatedEventHandler value)
Parameters
Type Name Description
SfPdfViewerControl.TextSearchInitiatedEventHandler value

AddStamp(UIElement, Int32)

Add custom view to the PDF viewer control.

Declaration
public void AddStamp(UIElement view, int pageNumber)
Parameters
Type Name Description
Windows.UI.Xaml.UIElement view

View to be added.
System.Int32 pageNumber

Page number to which the view has to be added.

AddStamp(UIElement, Int32, Point)

Add custom view to the PDF viewer control.

Declaration
public void AddStamp(UIElement view, int pageNumber, Point location)
Parameters
Type Name Description
Windows.UI.Xaml.UIElement view

View to be added.
System.Int32 pageNumber

Page number to which the view has to be added.
Windows.Foundation.Point location

Location in which the view has to be added.

AddStamp(UIElement, Int32, Rect)

Add custom view to the PDF viewer control.

Declaration
public void AddStamp(UIElement view, int pageNumber, Rect bounds)
Parameters
Type Name Description
Windows.UI.Xaml.UIElement view

View to be added.
System.Int32 pageNumber

Page number to which the view has to be added.
Windows.Foundation.Rect bounds

Bounds of the view.

ClearAllAnnotations()

Clears all the annotations added to the PDF Viewer.

Declaration
public void ClearAllAnnotations()

ClearAllAnnotations(Int32)

Delete all the annotations in the given page.

Declaration
public void ClearAllAnnotations(int pageNumber)
Parameters
Type Name Description
System.Int32 pageNumber

DeselectAnnotation(IAnnotation)

Deselect the annotation with given id

Declaration
public void DeselectAnnotation(IAnnotation annotation)
Parameters
Type Name Description
IAnnotation annotation

ExportAsImage(Int32)

Exports the specified page as MemoryStream

Declaration
public Task<Stream> ExportAsImage(int pageIndex)
Parameters
Type Name Description
System.Int32 pageIndex

The page index to be converted into MemoryStream.
Returns
Type Description
System.Threading.Tasks.Task<System.IO.Stream>

Returns the specified page as MemoryStream.

ExportAsImage(Int32, Int32)

Exports the specified pages as MemoryStreams.

Declaration
public Task<List<Stream>> ExportAsImage(int startIndex, int endIndex)
Parameters
Type Name Description
System.Int32 startIndex

The starting page index
System.Int32 endIndex

The ending page index
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.List<System.IO.Stream>>

Returns the specified pages as MemoryStreams

ExportAsImage(Int32, Int32, Single)

Exports the specified pages as MemoryStreams with respect to zoomFactor specified.

Declaration
public Task<List<Stream>> ExportAsImage(int startIndex, int endIndex, float zoomFactor)
Parameters
Type Name Description
System.Int32 startIndex

The starting page index.
System.Int32 endIndex

The ending page index.
System.Single zoomFactor

Zoom Factor in which the page is to be exported.
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.List<System.IO.Stream>>

Returns the specified pages as MemoryStreams with respect to zoom factor.

ExportAsImage(Int32, Single)

Exports the specified page as MemoryStream with respect to zoomfactor specified.

Declaration
public Task<Stream> ExportAsImage(int pageIndex, float zoomFactor)
Parameters
Type Name Description
System.Int32 pageIndex

The page index to be converted into Stream.
System.Single zoomFactor

Zoom Factor in which the page is to be exported.
Returns
Type Description
System.Threading.Tasks.Task<System.IO.Stream>

Returns the specified page as Stream with respect to zoom factor.

GetPage(Int32)

Outputs an Image, which represents a Portable Document Format (PDF) page's contents

Declaration
public Image GetPage(int pageIndex)
Parameters
Type Name Description
System.Int32 pageIndex

Index of the page to be extracted as image
Returns
Type Description
Windows.UI.Xaml.Controls.Image

Content of the page as Image

GetPage(Int32, Int32)

Outputs an Image, which represents a Portable Document Format (PDF) page's contents with custom magnification

Declaration
public Image GetPage(int pageIndex, int zoomFactor)
Parameters
Type Name Description
System.Int32 pageIndex

Index of the page to be extracted as image
System.Int32 zoomFactor

The magnification factor
Returns
Type Description
Windows.UI.Xaml.Controls.Image

Content of the page with custom magnification as Image

GetPages(Int32, Int32)

Outputs an array of Image, which represents a Portable Document Format (PDF) page's contents

Declaration
public Image[] GetPages(int startIndex, int endIndex)
Parameters
Type Name Description
System.Int32 startIndex

Index of the starting page
System.Int32 endIndex

Index of the ending page
Returns
Type Description
Windows.UI.Xaml.Controls.Image[]

Content of the page as Image array

GetPages(Int32, Int32, Int32)

Outputs an array of Image, which represents a Portable Document Format (PDF) page's contents with custom magnification

Declaration
public Image[] GetPages(int startIndex, int endIndex, int zoomFactor)
Parameters
Type Name Description
System.Int32 startIndex

Index of the starting page
System.Int32 endIndex

Content of the page as Image array
System.Int32 zoomFactor

The magnification factor
Returns
Type Description
Windows.UI.Xaml.Controls.Image[]

Content of the page with custom magnification as Image array

GetTextCoordinates(String, Int32, out List<PdfTextCoordinates>)

Search for the existence of a text and returns the text positions in a PDF page

Declaration
public void GetTextCoordinates(string targetText, int pageIndex, out List<PdfTextCoordinates> coordinatesList)
Parameters
Type Name Description
System.String targetText

The text to be searched
System.Int32 pageIndex

The targeted page index in which search to be performed
System.Collections.Generic.List<PdfTextCoordinates> coordinatesList

Returns the text coordinates available in the PDF page

GoToBookmark(PdfBookmark)

Navigates the PdfViewer to the location specified by the given bookmark destination

Declaration
public void GoToBookmark(PdfBookmark bookmark)
Parameters
Type Name Description
PdfBookmark bookmark

The bookmark object corresponding to the title clicked

GotoPage(Int32)

Navigates to the given page number.

Declaration
public void GotoPage(int pNumber)
Parameters
Type Name Description
System.Int32 pNumber

The page number to navigate to.

LoadDocument(PdfLoadedDocument)

Loads the PdfLoadedDocument into the PDF Viewer

Declaration
public void LoadDocument(PdfLoadedDocument loadedDocument)
Parameters
Type Name Description
PdfLoadedDocument loadedDocument

PdfLoadedDocument to be loaded

LoadDocument(Stream)

Loads the PDF document created with the stream into the PDF Viewer

Declaration
public void LoadDocument(Stream stream)
Parameters
Type Name Description
System.IO.Stream stream

Document stream

LoadDocument(Stream, String)

Loads the encrypted PDF document created from the stream into the PdfViewer control

Declaration
public void LoadDocument(Stream stream, string password)
Parameters
Type Name Description
System.IO.Stream stream

Document Stream
System.String password

Password

LoadDocument(StorageFile)

Loads a PDF document from a StorageFile

Declaration
public void LoadDocument(StorageFile storageFile)
Parameters
Type Name Description
Windows.Storage.StorageFile storageFile
Examples

The below code example shows how to load a PDF document from a StorageFile

var picker = new FileOpenPicker();
picker.SuggestedStartLocation = PickerLocationId.DocumentsLibrary;
picker.ViewMode = PickerViewMode.List;
picker.FileTypeFilter.Add(".pdf");
var file = await picker.PickSingleFileAsync();
if (file != null)
{
    pdfViewer.LoadDocument(file);
}

LoadDocumentAsync(PdfLoadedDocument)

Load the PDF document into the PdfViewer control

Declaration
public Task<bool> LoadDocumentAsync(PdfLoadedDocument loadedDocument)
Parameters
Type Name Description
PdfLoadedDocument loadedDocument
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

LoadDocumentAsync(Stream)

Declaration
public Task<bool> LoadDocumentAsync(Stream stream)
Parameters
Type Name Description
System.IO.Stream stream
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

LoadDocumentAsync(StorageFile, CancellationToken)

Loads a PDF document from a StorageFile

Declaration
public Task<bool> LoadDocumentAsync(StorageFile storageFile, CancellationToken cancellationToken = null)
Parameters
Type Name Description
Windows.Storage.StorageFile storageFile
System.Threading.CancellationToken cancellationToken

A cancellation token to receive notice of cancellation. This parameter is optional.
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>
Examples

The below code example shows how to load a PDF document from a StorageFile asynchronously

var picker = new FileOpenPicker();
picker.SuggestedStartLocation = PickerLocationId.DocumentsLibrary;
picker.ViewMode = PickerViewMode.List;
picker.FileTypeFilter.Add(".pdf");
var file = await picker.PickSingleFileAsync();
if (file != null)
{
    await pdfViewer.LoadDocumentAsync(file);
}

OnApplyTemplate()

Declaration
protected override void OnApplyTemplate()

Print()

Prints all pages in the viewer.

Declaration
public void Print()

PrintAsync(CancellationToken)

Prints the PDF.

Declaration
public Task PrintAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

When System.Threading.CancellationTokenSource.Cancel is called, the print operation is stopped.
Returns
Type Description
System.Threading.Tasks.Task

Task
Remarks

The method calls the to show the print previewer.As mentioned in the documentation, exceptions will be thrown if print cannot be performed.The exceptions will be propagated back to the caller of this method. We recommend catching these exceptions in the application code.

Examples

This code sample illustrates how to catch the print exceptions in the application code.

Try
{
   await pdfViewerControl.PrintAsync(cancellationToken);
}
catch
{
    ContentDialog printErrorDialog = new ContentDialog()
}

remove_TextFound(SfPdfViewerControl.TextFoundEventHandler)

Declaration
public void remove_TextFound(SfPdfViewerControl.TextFoundEventHandler value)
Parameters
Type Name Description
SfPdfViewerControl.TextFoundEventHandler value

remove_TextSearchCompleted(SfPdfViewerControl.TextSearchCompletedEventHandler)

Declaration
public void remove_TextSearchCompleted(SfPdfViewerControl.TextSearchCompletedEventHandler value)
Parameters
Type Name Description
SfPdfViewerControl.TextSearchCompletedEventHandler value

remove_TextSearchInitiated(SfPdfViewerControl.TextSearchInitiatedEventHandler)

Declaration
public void remove_TextSearchInitiated(SfPdfViewerControl.TextSearchInitiatedEventHandler value)
Parameters
Type Name Description
SfPdfViewerControl.TextSearchInitiatedEventHandler value

RemoveAnnotation(IAnnotation)

Clears the selected annotation.

Declaration
public void RemoveAnnotation(IAnnotation annotation)
Parameters
Type Name Description
IAnnotation annotation

Selected annotation to be deleted

Save()

Saves the PDF document

Declaration
public Stream Save()
Returns
Type Description
System.IO.Stream

Returns the stream of Saved PDF document

SaveAsync()

Asynchronously saves the PDF document

Declaration
public Task<Stream> SaveAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.IO.Stream>

ScrollToHorizontalOffset(Double)

Scrolls the content in SfPdfViewerControl to the specified horizontal offset position

Declaration
public void ScrollToHorizontalOffset(double offset)
Parameters
Type Name Description
System.Double offset

The position that the content in SfPdfViewerControl scrolls to

ScrollToVerticalOffset(Double)

Scrolls the content in SfPdfViewerControl to the specified vertical offset position

Declaration
public void ScrollToVerticalOffset(double offset)
Parameters
Type Name Description
System.Double offset

The position that the content in SfPdfViewerControl scrolls to

SearchNextText(String)

Search the next occurance of the text

Declaration
public void SearchNextText(string targetString)
Parameters
Type Name Description
System.String targetString

The text to be searched

SearchPrevText(String)

Search the previous occurance of the text

Declaration
public void SearchPrevText(string targetString)
Parameters
Type Name Description
System.String targetString

The text to be searched

SearchText(String)

Searches for the given text in the PDF and navigates to the first found instance.

Declaration
public bool SearchText(string targetText)
Parameters
Type Name Description
System.String targetText

The text to be searched.
Returns
Type Description
System.Boolean

SelectAnnotation(IAnnotation)

Select the annotation with given id

Declaration
public void SelectAnnotation(IAnnotation annotation)
Parameters
Type Name Description
IAnnotation annotation

Unload()

Declaration
public void Unload()

Unload(Boolean)

Unloads the PDF Viewer

Declaration
public void Unload(bool disposeDocumentStream)
Parameters
Type Name Description
System.Boolean disposeDocumentStream

Setting this parameter to true will dispose the loaded document completely. By default this parameter is set to true

ZoomTo(Int32)

Zooms the document to the specified percentage

Declaration
public void ZoomTo(int percentage)
Parameters
Type Name Description
System.Int32 percentage

The percentage between 100 to 300

Events

AnnotationAdded

Occurs when annotation is added.

Declaration
public event EventHandler<AnnotationAddedEventArgs> AnnotationAdded
Event Type
Type Description
System.EventHandler<AnnotationAddedEventArgs>

AnnotationDeselected

Occurs when annotation is deselected.

Declaration
public event EventHandler<AnnotationDeselectedEventArgs> AnnotationDeselected
Event Type
Type Description
System.EventHandler<AnnotationDeselectedEventArgs>

AnnotationModeChanged

Occurs when annotation mode changed.

Declaration
public event EventHandler<AnnotationModeChangedEventArgs> AnnotationModeChanged
Event Type
Type Description
System.EventHandler<AnnotationModeChangedEventArgs>

AnnotationMovedOrResized

Occurs when annotation is moved or resized.

Declaration
public event EventHandler<AnnotationMovedOrResizedEventArgs> AnnotationMovedOrResized
Event Type
Type Description
System.EventHandler<AnnotationMovedOrResizedEventArgs>

AnnotationRemoved

Occurs when annotation is removed.

Declaration
public event EventHandler<AnnotationRemovedEventArgs> AnnotationRemoved
Event Type
Type Description
System.EventHandler<AnnotationRemovedEventArgs>

AnnotationSelected

Occurs when annotation is selected.

Declaration
public event EventHandler<AnnotationSelectedEventArgs> AnnotationSelected
Event Type
Type Description
System.EventHandler<AnnotationSelectedEventArgs>

AnnotationTapped

Occurs when popup annotation is tapped.

Declaration
public event EventHandler<AnnotationTappedEventArgs> AnnotationTapped
Event Type
Type Description
System.EventHandler<AnnotationTappedEventArgs>

DocumentLoaded

Occurs when the PDF is loaded.

Declaration
public event EventHandler<DocumentLoadedEventArgs> DocumentLoaded
Event Type
Type Description
System.EventHandler<DocumentLoadedEventArgs>

FreeTextAnnotationEdited

Occurs when freetext annotation is edited

Declaration
public event EventHandler<FreeTextAnnotationEditedEventArgs> FreeTextAnnotationEdited
Event Type
Type Description
System.EventHandler<FreeTextAnnotationEditedEventArgs>

FreeTextAnnotationPopupAppearing

Occurs when the freetext popup appears

Declaration
public event EventHandler<FreeTextAnnotationPopupAppearingEventArgs> FreeTextAnnotationPopupAppearing
Event Type
Type Description
System.EventHandler<FreeTextAnnotationPopupAppearingEventArgs>

FreeTextAnnotationPopupDisappearing

Occurs when the freetext popup disappears

Declaration
public event EventHandler<FreeTextAnnotationPopupDisappearingEventArgs> FreeTextAnnotationPopupDisappearing
Event Type
Type Description
System.EventHandler<FreeTextAnnotationPopupDisappearingEventArgs>

FreeTextCalloutAnnotationMoved

Occurs when a freetext callout annotation is moved .

Declaration
public event EventHandler<FreeTextCalloutAnnotationMovedEventArgs> FreeTextCalloutAnnotationMoved
Event Type
Type Description
System.EventHandler<FreeTextCalloutAnnotationMovedEventArgs>

FreeTextCalloutAnnotationResized

Occurs when a freetext callout annotation is resized.

Declaration
public event EventHandler<FreeTextCalloutAnnotationResizedEventArgs> FreeTextCalloutAnnotationResized
Event Type
Type Description
System.EventHandler<FreeTextCalloutAnnotationResizedEventArgs>

HyperlinkPointerMoved

Occurs when a pointer is moved over a hyperlink.

Declaration
public event EventHandler<HyperlinkEventArgs> HyperlinkPointerMoved
Event Type
Type Description
System.EventHandler<HyperlinkEventArgs>

HyperlinkPointerPressed

Occurs when a hyperlink is pressed by the pointer device.

Declaration
public event EventHandler<HyperlinkEventArgs> HyperlinkPointerPressed
Event Type
Type Description
System.EventHandler<HyperlinkEventArgs>

InkEdited

Occurs when ink annotation is edited.

Declaration
public event EventHandler<InkEditedEventArgs> InkEdited
Event Type
Type Description
System.EventHandler<InkEditedEventArgs>

PageChanged

Occurs when the value of PageNumber is changed.

Declaration
public event EventHandler<PageChangedEventArgs> PageChanged
Event Type
Type Description
System.EventHandler<PageChangedEventArgs>

PageClicked

Occurs when a Page of the PDF document is clicked in SfPdfViewerControl.

Declaration
public event EventHandler<PageClickedEventArgs> PageClicked
Event Type
Type Description
System.EventHandler<PageClickedEventArgs>

PagePointerPressed

Occurs when the pointer device initiates a Press action within the page.

Declaration
public event EventHandler<PagePointerEventArgs> PagePointerPressed
Event Type
Type Description
System.EventHandler<PagePointerEventArgs>

PagePointerReleased

Occurs when the pointer device that previously initiated a Press action is released, while within the page.

Declaration
public event EventHandler<PagePointerEventArgs> PagePointerReleased
Event Type
Type Description
System.EventHandler<PagePointerEventArgs>

PopupAnnotationAdded

Occurs when a popup annotation is added in the PDF.

Declaration
public event EventHandler<PopupAnnotationAddedEventArgs> PopupAnnotationAdded
Event Type
Type Description
System.EventHandler<PopupAnnotationAddedEventArgs>

PopupEdited

Occurs when popup annotation is edited.

Declaration
public event EventHandler<PopupEditedEventArgs> PopupEdited
Event Type
Type Description
System.EventHandler<PopupEditedEventArgs>

PopupMoved

Occurs when popup annotation is moved.

Declaration
public event EventHandler<PopupMovedEventArgs> PopupMoved
Event Type
Type Description
System.EventHandler<PopupMovedEventArgs>

PrintCompleted

Occurs to provide information on how much of content were submitted to printing subsystem

Declaration
public event EventHandler<PrintCompletedEventArgs> PrintCompleted
Event Type
Type Description
System.EventHandler<PrintCompletedEventArgs>

PrintProgress

Occurs to provide information on how much of content were submitted to printing subsystem

Declaration
public event EventHandler<PrintProgressEventArgs> PrintProgress
Event Type
Type Description
System.EventHandler<PrintProgressEventArgs>

PrintStarted

Occurs when the print operation is initiated

Declaration
public event EventHandler<PrintStartedEventArgs> PrintStarted
Event Type
Type Description
System.EventHandler<PrintStartedEventArgs>

PrintTaskRequested

Declaration
public event EventHandler<SfPdfViewerPrintTaskRequestedEventArgs> PrintTaskRequested
Event Type
Type Description
System.EventHandler<SfPdfViewerPrintTaskRequestedEventArgs>

ScrollChanged

Occurs when the content in the SfPdfViewerControl is being scrolled

Declaration
public event EventHandler<ScrollChangedEventArgs> ScrollChanged
Event Type
Type Description
System.EventHandler<ScrollChangedEventArgs>

SemanitcZoomChanged

Occurs when the semantic zoom is changed

Declaration
public event EventHandler<SemanticZoomViewChangedEventArgs> SemanitcZoomChanged
Event Type
Type Description
System.EventHandler<Windows.UI.Xaml.Controls.SemanticZoomViewChangedEventArgs>

SemanticZoomChanged

Occurs when the semantic zoom is changed

Declaration
public event EventHandler<SemanticZoomViewChangedEventArgs> SemanticZoomChanged
Event Type
Type Description
System.EventHandler<Windows.UI.Xaml.Controls.SemanticZoomViewChangedEventArgs>

ShapeEdited

Occurs when shape annotation is edited.

Declaration
public event EventHandler<ShapeEditedEventArgs> ShapeEdited
Event Type
Type Description
System.EventHandler<ShapeEditedEventArgs>

TextFound

Occurs when an instance of the target text is found

Declaration
public event SfPdfViewerControl.TextFoundEventHandler TextFound
Event Type
Type Description
SfPdfViewerControl.TextFoundEventHandler

TextMarkupEdited

Occurs when textmarkup annotation is edited.

Declaration
public event EventHandler<TextMarkupEditedEventArgs> TextMarkupEdited
Event Type
Type Description
System.EventHandler<TextMarkupEditedEventArgs>

TextSearchCompleted

Occurs when the document is completely scanned for the target text

Declaration
public event SfPdfViewerControl.TextSearchCompletedEventHandler TextSearchCompleted
Event Type
Type Description
SfPdfViewerControl.TextSearchCompletedEventHandler

TextSearchInitiated

Occurs when the text search is initiated

Declaration
public event SfPdfViewerControl.TextSearchInitiatedEventHandler TextSearchInitiated
Event Type
Type Description
SfPdfViewerControl.TextSearchInitiatedEventHandler

ZoomChanged

Occurs when the value of Zoom is changed.

Declaration
public event EventHandler<ZoomChangedEventArgs> ZoomChanged
Event Type
Type Description
System.EventHandler<ZoomChangedEventArgs>

Extension Methods