PdfViewer.LoadDocument(String) Method

Loads the PDF document from the specified path.

Namespace: DevExpress.XtraPdfViewer

Assembly: DevExpress.XtraPdfViewer.v18.2.dll

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

If the PdfViewer.DetachStreamAfterLoadComplete property is set to false (default mode) the PDF Viewer locks a file until it is opened in the PDF Viewer. If you want the PDF Viewer does not lock the file, set the PdfViewer.DetachStreamAfterLoadComplete property to true.

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 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-using-the-pdfviewer-control-e4696/CS/PdfViewerSample/Form1.cs#L11

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

how-to-export-acroform-data-to-xml-t273545/CS/ExportAcroFormDocument/Form1.cs#L10

// Load a PDF document with AcroForm data.
pdfViewer1.LoadDocument("..\\..\\AcroForm.pdf");

how-to-import-acroform-data-from-xml-t273679/CS/ImportAcroForm/Form1.cs#L10

// Load a PDF document with AcroForm data.
pdfViewer1.LoadDocument("..\\..\\InitialAcroForm.pdf");

how-to-add-a-custom-bar-button-item-to-the-popup-menu-t328781/CS/CustomPopupMenu/Form1.cs#L9

    InitializeComponent();
    pdfViewer1.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-using-the-pdfviewer-control-e4696/VB/PdfViewerSample/Form1.vb#L14

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

how-to-export-acroform-data-to-xml-t273545/VB/ExportAcroFormDocument/Form1.vb#L12

' Load a PDF document with AcroForm data.
pdfViewer1.LoadDocument("..\..\AcroForm.pdf")

how-to-import-acroform-data-from-xml-t273679/VB/ImportAcroForm/Form1.vb#L12

' Load a PDF document with AcroForm data.
pdfViewer1.LoadDocument("..\..\InitialAcroForm.pdf")

how-to-add-a-custom-bar-button-item-to-the-popup-menu-t328781/VB/CustomPopupMenu/Form1.vb#L11

    InitializeComponent()
    pdfViewer1.LoadDocument("..\..\Demo.pdf")
End Sub