PdfViewer Class

Displays PDF files in WinForms applications without the need to install any third-party software on end-user machines.

Namespace: DevExpress.XtraPdfViewer

Assembly: DevExpress.XtraPdfViewer.v18.1.dll

Declaration

C#

[TypeConverter("DevExpress.XtraPdfViewer.Design.PdfViewerTypeConverter,DevExpress.XtraPdfViewer.v18.1.Design")]
[ToolboxTabName("DX.18.1: Common Controls")]
[ToolboxBitmap(typeof(ResFinder), "Bitmaps256.PdfViewer.bmp")]
public class PdfViewer :
    XtraUserControl,
    ICommandAwareControl<PdfViewerCommandId>,
    IServiceContainer,
    IServiceProvider,
    IPdfViewer

VB.NET

<ToolboxTabName("DX.18.1: Common Controls")>
<TypeConverter("DevExpress.XtraPdfViewer.Design.PdfViewerTypeConverter,DevExpress.XtraPdfViewer.v18.1.Design")>
<ToolboxBitmap(GetType(ResFinder), "Bitmaps256.PdfViewer.bmp")>
Public Class PdfViewer
    Inherits XtraUserControl
    Implements ICommandAwareControl(Of PdfViewerCommandId),
               IServiceContainer,
               IServiceProvider,
               IPdfViewer

Remarks

This control provides the user interface for end-users to open, view, navigate and print PDF documents.

For a design-time tutorial, see Lesson 1 - Creating a PDF Viewer.

Example

The following example illustrates how to load an existing PDF file into the PdfViewer control. To do this, it’s necessary to drop the PdfViewer control onto the form, create a Ribbon via the PdfViewer’s smart tag and call the PdfViewer.LoadDocument method.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-show-a-pdf-file-using-the-pdfviewer-control-e4696

Form1.cs

using System;
using System.Windows.Forms;

namespace PdfViewerSample {
    public partial class Form1 : Form {
        public Form1() {
            InitializeComponent();
        }

        private void Form1_Load(object sender, EventArgs e) {
            this.pdfViewer1.LoadDocument(@"..\..\Report.pdf");
        }
    }
}

Form1.vb

Imports System
Imports System.Windows.Forms

Namespace PdfViewerSample
    Partial Public Class Form1
        Inherits Form

        Public Sub New()
            InitializeComponent()
        End Sub

        Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs) Handles MyBase.Load
            Me.pdfViewer1.LoadDocument("..\..\Report.pdf")
        End Sub
    End Class
End Namespace

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the PdfViewer class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-replace-standard-pdf-viewer-control-command-with-your-own-custom-command-t328206/CS/ViewerCustomCommand/CustomNextPageCommand.cs#L8

public class CustomNextPageCommand : PdfNextPageCommand {
    public CustomNextPageCommand(PdfViewer control)
        : base(control) {

how-to-use-the-pdf-printer-settings-t171205/CS/PdfPrinterSettingsDemo/Form1.cs#L16

// Create a PDF Viewer instance and load a PDF into it.
PdfViewer pdfViewer = this.pdfViewer1;
pdfViewer.LoadDocument(@"..\..\Demo.pdf");

VB.NET

how-to-replace-standard-pdf-viewer-control-command-with-your-own-custom-command-t328206/VB/ViewerCustomCommand/Form1.vb#L9

Private Sub ReplacePdfViewerCommandFactoryService(ByVal control As PdfViewer)
    Dim service As IPdfViewerCommandFactoryService = control.GetService(Of IPdfViewerCommandFactoryService)()

how-to-use-the-pdf-printer-settings-t171205/VB/PdfPrinterSettingsDemo/Form1.vb#L17

' Create a PDF Viewer instance and load a PDF into it.
Dim pdfViewer As PdfViewer = Me.pdfViewer1
pdfViewer.LoadDocument("..\..\Demo.pdf")

Implements

IXtraResizableControl

Inheritance

Object

MarshalByRefObject

Component

Control

ScrollableControl

ContainerControl

UserControl

XtraUserControl

PdfViewer