PrintingSystemBase.LoadDocument(Stream) Method

Loads a document from a Stream object, containing data in a native XML format (PRNX).

Namespace: DevExpress.XtraPrinting

Assembly: DevExpress.Printing.v18.2.Core.dll

Declaration

C#

public void LoadDocument(
    Stream stream
)

VB.NET

Public Sub LoadDocument(
    stream As Stream
)

Parameters

Name	Type	Description
stream	Stream	A Stream object containing PRNX data.

Remarks

Use the PrintingSystemBase.SaveDocument and LoadDocument methods to save a printing system‘s document (all its pages and bricks) to a PRNX file, and then load it into another printing system instance. This may be required, for example, when it’s necessary to pass a generated report to another machine that doesn’t have access to the same data as the machine that generated the report.

Prior to saving a printing system document, it must be created by calling the LinkBase.CreateDocument method.

The printing system’s PrintingSystemBase.ExportOptions provide the ExportOptions.NativeFormat property, which specifies how a document should be saved to a PRNX file. For example, to reduce the size of the resulting PRNX file, set the NativeFormatOptions.Compressed property to true.

Note

A note regarding the use of this method in Silverlight applications:

Documents generated by XtraReports or on the server side of a Silverlight application can contain elements that are not native to Silverlight.

For this reason, only use the LoadDocument method in Silverlight to open PRNX documents that are generated by the Printing-Exporting Library (including documents that are generated by DevExpress controls for Silverlight).

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#

Reporting_how-to-implement-a-custom-report-service-providing-report-documents-layouts-e4445/CS/ClientApp/Form1.cs#L43

PrintPreviewFormEx preview = new PrintPreviewFormEx() { PrintingSystem = new PrintingSystem() };
preview.PrintingSystem.LoadDocument(memoryStream);
preview.ShowDialog();

Reporting_how-to-save-and-restore-a-report-document-from-a-stream-e211/CS/Form1.cs#L36

// Load the document from a stream.
ps.LoadDocument(stream);

Reporting_how-to-save-print-a-selected-page-of-a-report-in-a-web-application-t113072/CS/WebApplication1/ExportReport.aspx.cs#L17

PrintingSystem ps = new PrintingSystem();
ps.LoadDocument(ms);
PdfExportOptions opts = new PdfExportOptions();

Reporting_report-server-how-to-print-or-export-a-report-from-code-in-a-winforms-application-t317142/CS/ReportServerWinForms/MainForm.cs#L44

using(MemoryStream stream = new MemoryStream(prnx)) {
    report.PrintingSystem.LoadDocument(stream);
}

VB.NET

Reporting_how-to-implement-a-custom-report-service-providing-report-documents-layouts-e4445/VB/ClientApp/Form1.vb#L41

Dim preview As New PrintPreviewFormEx() With {.PrintingSystem = New PrintingSystem()}
preview.PrintingSystem.LoadDocument(memoryStream)
preview.ShowDialog()

Reporting_how-to-save-and-restore-a-report-document-from-a-stream-e211/VB/Form1.vb#L38

' Load the document from a stream.
ps.LoadDocument(stream)

Reporting_how-to-save-print-a-selected-page-of-a-report-in-a-web-application-t113072/VB/WebApplication1/ExportReport.aspx.vb#L19

Dim ps As New PrintingSystem()
ps.LoadDocument(ms)
Dim opts As New PdfExportOptions()

Reporting_report-server-how-to-print-or-export-a-report-from-code-in-a-winforms-application-t317142/VB/ReportServerWinForms/MainForm.vb#L43

Using stream As New MemoryStream(prnx)
    report.PrintingSystem.LoadDocument(stream)
End Using