PdfViewer.LoadDocument(Stream) Method

Loads a PDF document from the specified stream.

Namespace: DevExpress.XtraPdfViewer

Assembly: DevExpress.XtraPdfViewer.v18.2.dll

Declaration

C#

public void LoadDocument(
    Stream stream
)

VB.NET

Public Sub LoadDocument(
    stream As Stream
)

Parameters

Name	Type	Description
stream	Stream	A Stream class descendant.

Remarks

If the PdfViewer.DetachStreamAfterLoadComplete property is set to false (default mode), the input stream should not be closed until a document is opened.

If you want to close the stream when a document is opened, set the PdfViewer.DetachStreamAfterLoadComplete property to true before specifying the document source.

Example

The following example illustrates how to load a document into the PDF Viewer from a stream at runtime.

To accomplish this task: create a FileStream object with the specified file path to open the existing file, and call one of the PdfViewer.LoadDocument overloaded method with this stream object passed as a parameter.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-load-a-pdf-document-from-a-stream-t270045

Form1.cs

using System.IO;
using System.Windows.Forms;

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

            // Load a document from the stream.
            FileStream stream = new FileStream("..\\..\\Demo.pdf", FileMode.Open);
            pdfViewer1.LoadDocument(stream);
        }
    }
}

Form1.vb

Imports System.IO
Imports System.Windows.Forms

Namespace LoadDocumentFromStream
    Partial Public Class Form1
        Inherits Form

        Public Sub New()
            InitializeComponent()

            ' Load a document from the stream.
            Dim stream As New FileStream("..\..\Demo.pdf", FileMode.Open)
            pdfViewer1.LoadDocument(stream)
        End Sub
    End Class
End Namespace

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the LoadDocument(Stream) 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#

how-to-determine-the-page-number-of-a-clicked-pdf-page-t121897/CS/PageHitTest/Form1.cs#L15

    Stream stream = GetResourceStream("PageHitTest.demo.pdf");
    pdfViewer.LoadDocument(stream);
}

how-to-load-a-pdf-document-from-a-stream-t270045/CS/LoadDocumentFromStream/Form1.cs#L11

    FileStream stream = new FileStream("..\\..\\Demo.pdf", FileMode.Open);
    pdfViewer1.LoadDocument(stream);
}

VB.NET

how-to-determine-the-page-number-of-a-clicked-pdf-page-t121897/VB/PageHitTest/Form1.vb#L15

    Dim stream As Stream = GetResourceStream("PageHitTest.demo.pdf")
    pdfViewer.LoadDocument(stream)
End Sub

how-to-load-a-pdf-document-from-a-stream-t270045/VB/LoadDocumentFromStream/Form1.vb#L13

    Dim stream As FileStream = New FileStream("..\..\Demo.pdf", FileMode.Open)
    pdfViewer1.LoadDocument(stream)
End Sub