PdfViewer.LoadDocument(String) Method

Loads the PDF document from the specified path.

Namespace: DevExpress.XtraPdfViewer

Assembly: DevExpress.XtraPdfViewer.v23.2.dll

NuGet Package: DevExpress.Win.PdfViewer

Declaration

C#

public void LoadDocument(
    string path
)

VB.NET

Public Sub LoadDocument(
    path As String
)

Parameters

Name	Type	Description
path	String	A string specifying the path to the PDF document.

Remarks

The PDF Viewer locks a file until it is opened in the PDF Viewer. Set the PdfViewer.DetachStreamAfterLoadComplete property to true to keep the file unlocked.

Example

The following example illustrates how to load a PDF file into the PdfViewer control. Drop the PdfViewer control onto the form, create a Ribbon via the PdfViewer’s smart tag and call the PdfViewer.LoadDocument method.

View Example

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 LoadDocument(String) method.

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#

pdf-document-api-fill-interactive-form-fields/CS/PdfFormFilling/PdfFormFilling.cs#L15

    InitializeComponent();
    pdfViewer1.LoadDocument(filePath + fileName + ".pdf");
}

how-to-show-a-pdf-file-in-the-pdfviewer-winforms/CS/PdfViewerSample/Form1.cs#L16

{
    this.pdfViewer1.LoadDocument(@"..\..\Report.pdf");
}

winforms-pdf-viewer-replace-standard-command-with-custom-command/CS/ViewerCustomCommand/Form1.cs#L18

InitializeComponent();
pdfViewer1.LoadDocument("..\\..\\Demo.pdf");
ReplacePdfViewerCommandFactoryService(pdfViewer1);

pdf-document-api-operate-pdf-content-at-runtime/CS/WindowsFormsApplication1/MainForm.cs#L18

private void MainForm_Load(object sender, System.EventArgs e) {
    pdfViewer1.LoadDocument(@"..\..\TextExtraction.pdf");
    repositoryItemButtonEdit3.ButtonClick += repositoryItemButtonEdit3_ButtonClick;

pdf-viewer-use-the-pdf-printer-settings-to-print-a-file/CS/PdfPrinterSettingsDemo/Form1.cs#L17

PdfViewer pdfViewer = this.pdfViewer1;
pdfViewer.LoadDocument(@"..\..\Demo.pdf");

VB.NET

pdf-document-api-fill-interactive-form-fields/VB/PdfFormFilling/PdfFormFilling.vb#L17

    InitializeComponent()
    pdfViewer1.LoadDocument(filePath & fileName & ".pdf")
End Sub

how-to-show-a-pdf-file-in-the-pdfviewer-winforms/VB/PdfViewerSample/Form1.vb#L14

Private Sub btnLoadFile_ItemClick(ByVal sender As Object, ByVal e As ItemClickEventArgs)
    pdfViewer1.LoadDocument("..\..\Report.pdf")
End Sub

winforms-pdf-viewer-replace-standard-command-with-custom-command/VB/ViewerCustomCommand/Form1.vb#L18

InitializeComponent()
pdfViewer1.LoadDocument("..\..\Demo.pdf")
ReplacePdfViewerCommandFactoryService(pdfViewer1)

pdf-document-api-operate-pdf-content-at-runtime/VB/WindowsFormsApplication1/MainForm.vb#L20

Private Sub MainForm_Load(ByVal sender As Object, ByVal e As System.EventArgs)
    pdfViewer1.LoadDocument("..\..\TextExtraction.pdf")
    AddHandler repositoryItemButtonEdit3.ButtonClick, AddressOf repositoryItemButtonEdit3_ButtonClick

pdf-viewer-use-the-pdf-printer-settings-to-print-a-file/VB/PdfPrinterSettingsDemo/Form1.vb#L19

Dim pdfViewer As PdfViewer = pdfViewer1
pdfViewer.LoadDocument("..\..\Demo.pdf")
' If required, declare and specify the system printer settings.