Concept and Features

2 Jun 202113 minutes to read

Essential PDF Viewer can display PDF files, and print and export the pages as raster images. This section explains about the various functionalities available in the Essential PDF viewer for WPF.

Viewing PDF Files

A PDF can be loaded into the PDF Viewer either through the File Open dialog available in the toolbar or through the Load method. It also requests passwords to open encrypted documents.

  • c#
  • //Initialize PDF Viewer.
    
    PdfViewerControl pdfViewer1 = new PdfViewerControl();
    
    
    
    //Load the PDF.
    
    pdfViewer1.Load("Template.pdf");
  • vbnet
  • 'Initialize PDF Viewer.
    
    Private pdfViewer1 As New PdfViewerControl()
    
    
    
    'Load the PDF.
    
    pdfViewer1.Load("Template.pdf")

    You can load an encrypted document by using the overload in the Load method.

  • c#
  • //Initialize PDF Viewer.
    
    PdfViewerControl pdfViewer1 = new PdfViewerControl();
    
    
    
    //Load the PDF.
    
    pdfViewer1.Load("Template.pdf", "password");
  • vbnet
  • 'Initialize PDF Viewer.
    
    Private pdfViewer1 As New PdfViewerControl()
    
    
    
    'Load the PDF.
    
    pdfViewer1.Load("Template.pdf", "password")

    You can also load the PDF document by setting its path to the ItemSource property

  • c#
  • //Initialize PDF Viewer.
    
    PdfViewerControl pdfViewer1 = new PdfViewerControl();
    
    
    
    //Load the PDF.
    
    pdfViewer1. ItemSource="Template.pdf";
  • vbnet
  • 'Initialize PDF Viewer.
    
    Private pdfViewer1 As New PdfViewerControl()
    
    
    
    'Load the PDF.
    
    pdfViewer1. ItemSource = "Template.pdf"

    Saving the PDF document

    PDF Viewer also allows you to save the PDF document that is being displayed in the PDF Viewer. The following code example illustrates the same.

  • c#
  • //Acquire the document loaded into the PDF Viewer
    
    PdfLoadedDocument lDoc = pdfviewer1.LoadedDocument;
    
    
    
    //Save the document
    
    lDoc.Save("Sample.pdf");
  • vbnet
  • 'Acquire the document loaded into the PDF Viewer
    
    Dim lDoc As PdfLoadedDocument = pdfviewer1.LoadedDocument
    
    
    
    'Save the document
    
    lDoc.Save("Sample.pdf")

    PDF Viewer allows you to navigate through the pages of the PDF document. The following code example illustrates the navigation to page 2 of the PDF document.

  • c#
  • //Navigate to page 2
    
    pdfviewer1.GotoPage(2);
  • vbnet
  • 'Navigate to page 2
    
    pdfviewer1.GotoPage(2)

    Magnifying PDF documents

    PDF Viewer allows you to magnify the PDF document that is being displayed. The following code examples can be used to perform this action.

  • c#
  • //Magnify the document to 150%
    
    pdfviewer1.ZoomTo(150);
  • vbnet
  • 'Magnify the document to 150%
    
    pdfviewer1.ZoomTo(150)

    The magnification can also be set by updating the Zoom property of the PDF Viewer.

  • c#
  • //Magnify the document to 150%
    
    pdfviewer1.Zoom = 250;
  • vbnet
  • 'Magnify the document to 150%
    
    pdfviewer1.Zoom = 250

    Current magnification percentage of the PDF Viewer can be acquired with the use of the property ZoomPercentage

  • c#
  • //Acquire current zoom percentage
    
    int currentZoomPercentage = pdfviewer1.ZoomPercentage;
  • vbnet
  • ' Acquire current zoom percentage 
    
    Dim currentZoomPercentage As Integer = pdfviewer1.ZoomPercentage

    Zoom mode of the PDF viewer can be set using the following code example.

  • c#
  • //Setting zoom mode to the PDF Viewer
    
    pdfviewer1.ZoomMode = Syncfusion.Windows.PdfViewer.ZoomMode.FitWidth;
  • vbnet
  • 'Setting zoom mode to the PDF Viewer
    
    pdfviewer1.ZoomMode = Syncfusion.Windows.PdfViewer.ZoomMode.FitWidth

    Acquiring total number of pages

    PDF Viewer provides the total number of the pages in the PDF document that is being loaded into the PDF Viewer. This value can be acquired with the help of PageCount property in the PDF Viewer control, the following code example illustrates the same.

  • c#
  • // Acquiring the total number of pages in the document being loaded  
    
    int pageCount = pdfviewer1.PageCount;
  • vbnet
  • 'Acquiring the total number of pages in the document being loaded 
    
    Dim pageCount As Integer = pdfviewer1.PageCount

    Changing the color of the Loading Indicator

    PDF Viewer allows you to change the color of the loading indicator displayed when loading the PDF document. The following code example illustrates the same.

  • c#
  • // Changing the color of the loading indicator to Red
    
    pdfviewer1.LoadingIndicator.LoaderColor = System.Windows.Media.Color.FromArgb(255, 255, 0, 0);
  • vbnet
  • 'Changing the color of the loading indicator to Red
    
    pdfviewer1.LoadingIndicator.LoaderColor = System.Windows.Media.Color.FromArgb(255, 255, 0, 0)

    Changing the text displayed in the loading indicator

    PDF Viewer allows you to change the text displayed in the loading indicator. The following code example illustrates the same.

  • c#
  • // Changing the text displayed in the loading indicator
    
    pdfviewer1. LoadingIndicator.LoadingMessage = "Document loading";
  • vbnet
  • 'Changing the text displayed in the loading indicator
    
    pdfviewer1.LoadingIndicator.LoadingMessage = "Document loading"

    Toggling visibility of the tool bar

    PDF Viewer supports showing and hiding toolbar, when you feel to customize the toolbar, you can hide the default toolbar of the PDF Viewer. The following code example hides the default toolbar in the PDF Viewer control.

  • c#
  • // Hiding the default toolbar of the PDF Viewer
    
    pdfviewer1.ShowToolbar = false;
  • vbnet
  • ' Hiding the default toolbar of the PDF Viewer
    
    pdfviewer1.ShowToolbar = False

    Toggling visibility of the scroll bar

    PDF Viewer supports showing and hiding scrollbar, when you feel to use the PDF Viewer only with the touch support, you can hide the default scrollbars of the PDF Viewer. The following code example hides the scrollbar in the PDF Viewer control.

  • c#
  • // Hiding the scrollbar of the PDF Viewer
    
    pdfviewer1.ShowScrollbar = false;
  • vbnet
  • ' Hiding the scrollbar of the PDF Viewer
    
    pdfviewer1.ShowScrollbar = False

    Acquiring current page being displayed

    PDF Viewer supports acquiring the index of the page being displayed in the PDF Viewer at any moment. The following code example illustrates the same.

  • c#
  • // Acquiring the number of page being displayed in the Viewer  
    
    int pageCount = pdfviewer1.CurrentPageIndex;
  • vbnet
  • ' Acquiring the number of page being displayed in the Viewer  
    
    Dim pageCount As Integer = pdfviewer1. CurrentPageIndex

    Enabling and Disabling Notification bar

    Notification bar is a part of the PDF Viewer that is used to display when an unexpected error occurs in the PDF Viewer control. You can suppress the display of the Notification bar by setting the EnableNotificationBar property to false. The following code example illustrate the same.

  • c#
  • // Hiding the scrollbar of the PDF Viewer
    
    pdfviewer1.EnableNotificationBar= false;
  • vbnet
  • ' Hiding the scrollbar of the PDF Viewer
    
    pdfviewer1.EnableNotificationBar= False

    Printing PDF Files

    PDF Viewer allows printing loaded PDFs using the Print button in the toolbar. The following Print dialog opens upon triggering the Print button.

    Concept-and-Features_images1

    Silent Printing

    The PrintDocument property of PdfViewerControl returns System.Drawing.Printing.PrintDocument that helps to complete printing using PrintDialog. This type of printing can be used when trying to print the PDF document with the custom printer settings. The following code sample demonstrates this:

  • c#
  • PrintDialog dialog = new PrintDialog();
    
    dialog.AllowPrintToFile = true;         
    
    dialog.Document = viewer.PrintDocument;
    
    dialog.Document.Print();
  • vbnet
  • Dim dialog As New PrintDialog()
    
    dialog.AllowPrintToFile = True
    
    dialog.Document = viewer.PrintDocument
    
    dialog.Document.Print()

    When you prefer to perform Silent printing with the default printer settings, then using Print method in the PDF Viewer control is the best approach. The following code example illustrates the same.

  • c#
  • // Printing document using Print method
    
    pdfviewer1.Print();
  • vbnet
  • ' Printing document using Print method
    
    pdfviewer1.Print()

    Exporting PDF

    Exporting PDFs as Raster Images

    Essential PDF Viewer allows selected pages to be exported as raster images. Exporting can be done using the ExportAsImage method. This option helps to convert a PDF into an image.

  • c#
  • Bitmap img = pdfViewer1.ExportAsImage(0);
    
    
    
    // Save the image.
    
    img.Save("Sample.png", ImageFormat.Png);
  • vbnet
  • Dim img As Bitmap = pdfViewer1.ExportAsImage(0)
    
    
    
    ' Save the image.
    
    img.Save("Sample.png", ImageFormat.Png)

    You can also specify the page range instead of converting each page.

  • c#
  • Bitmap[] img = pdfViewer1.ExportAsImage(0, 3);
  • vbnet
  • Dim img() As Bitmap = pdfViewer1.ExportAsImage(0, 3)

    Exporting PDFs as Vector Images

    Exporting PDFs as vector images can be done using the ExportAsMetafile method. The following code sample demonstrates how a PDF document can be exported as a Metafile.

  • c#
  • Metafile img = pdfViewer1.ExportAsMetafile(0);
    
    
    
    // Save the image
    
    img.Save("Sample.emf", ImageFormat.Emf);
  • vbnet
  • Dim img As Metafile = pdfViewer1.ExportAsMetafile(0)
    
    
    
    ' Save the image
    
    img.Save("Sample.emf", ImageFormat.Emf)

    You can also specify the page range instead of converting each page individually.

  • c#
  • Metafile[] img = pdfViewer1.ExportAsMetafile(0, 3);
  • vbnet
  • Dim img() As Metafile = pdfViewer1.ExportAsMetafile(0, 3)

    Searching Text

    Essential PDF Viewer allows you to search and highlight the text in the PDF document. The search box appears when Ctrl+F is pressed and searches the text in the PDF document as displayed in the following screenshot.

    Concept-and-Features_images2

    The PDF Viewer control also supports searching text in the PDF document with the help of the following API. The FindText method returns true when the text given is found in the document. The dictionary contains the page index and the list of rectangular coordinates of the text found in that page. The following code example illustrates how text search can be achieved in the PDF Viewer control.

  • c#
  • bool IsMatchFound;
    
    pdfViewerControl1.Load("../../Data/Barcode.pdf");
    
    
    
    //Get the occurrences of the target text and location.
    
    Dictionary<int, List<RectangleF>> 
    
              textSearch = new Dictionary<int, List<RectangleF>>();
    
    IsMatchFound = pdfViewerControl1.FindText("targetText", out textSearch);
  • vbnet
  • Dim IsMatchFound As Boolean
    
    pdfViewerControl1.Load("../../Data/Barcode.pdf")
    
    
    
    'Get the occurrences of the target text and location.
    
    Dim textSearch As New Dictionary(Of Integer, List(Of RectangleF))()
    
    IsMatchFound = pdfViewerControl1.FindText("targetText", textSearch)

    Essential PDF Viewer provides support for URI annotations (hyperlinks) in the PDF document that enables the URI available in the PDF document to be opened in the browser just by clicking it. This also supports a few events that are listed in the previous table.

    Event Table

    Event Description Arguments Type
    HyperLinkMouseHover This event is triggered when the mouse pointer is placed over the URL. N/A N/A
    HyperLinkMouseClicked This event is triggered when the URL in the PDF document is clicked. N/A N/A

    Events Supported in the PDF Viewer

    The Essential PDF viewer for WPF also provides several events that enables you to design/modify the existing behavior according to your requirement. The following table lists out the events available in the PDF viewer and their functionalities.

    Events Table

    Event Description Arguments Type
    DocumentLoaded This event is triggered after the PDF is successfully loaded. N/A N/A
    HyperLinkMouseHover This event is triggered when the mouse pointer is placed over the URL. N/A N/A
    HyperLinkMouseClicked This event is triggered when the URL in the PDF document is clicked. N/A N/A

    In spite of the above event the following events are supported in the PdfDocumentView control.

    Event Table

    Event Description Arguments Type
    NavigationButtonStatesChanged This event is triggered when there is a change in the states of the navigation buttons N/A N/A
    CurrentPageChanged This event is triggered when there is a change in the index of the page being displayed N/A N/A
    ZoomChanged This event is triggered when there is change in the current zoom factor. N/A N/A