XtraReport.SaveDocument(Stream, NativeFormatOptions) Method

Saves the report document to the specified stream in the XML-based PRNX format.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v20.2.dll

NuGet Packages: DevExpress.Reporting.Core, DevExpress.WindowsDesktop.Reporting.Core

Declaration

C#

public void SaveDocument(
    Stream stream,
    NativeFormatOptions options = null
)

VB.NET

Public Sub SaveDocument(
    stream As Stream,
    options As NativeFormatOptions = Nothing
)

Parameters

Name	Type	Description
stream	Stream	The stream to save the report document to.

Optional Parameters

Name	Type	Default	Description
options	NativeFormatOptions	null	PRNX options to apply to the saved document. You can omit this parameter or set it to null (Nothing in Visual Basic) to use the ExportOptions.NativeFormat settings.

Remarks

If a document has not been generated for the report, the report’s CreateDocument() method is called before the document is saved.

The code sample below shows how to save a report to a stream.

C#

using DevExpress.XtraReports.UI;
using System;
using System.IO;
// ...
// Create a simple report.
XtraReport report = new XtraReport()
{
    Name = "SimpleReport",
    Bands = {
        new DetailBand() {
            Controls = {
                new XRLabel() {
                    Text = "Simple Report"
                }
            }
        }
    }
};
// Create the report document file in the user's Downloads folder.
FileStream stream = File.Open(
    Environment.GetFolderPath(Environment.SpecialFolder.UserProfile) + @"\Downloads\" + report.Name + ".prnx",
    FileMode.Create);
// Save the report to the created file.
report.SaveDocument(stream);

VB.NET

Imports DevExpress.XtraReports.UI
Imports System
Imports System.IO
' ...
' Create a simple report            
Dim report = New XtraReport() With {.Name = "SimpleReport"}
Dim band = New DetailBand()
Dim control = New XRLabel() With {.Text = "Simple Report"}
band.Controls.Add(control)
report.Bands.Add(band)

' Create the report document file in the user's Downloads folder.
Dim stream As FileStream = File.Open(Environment.GetFolderPath(Environment.SpecialFolder.UserProfile) _
                                     & "\Downloads\" & report.Name & ".prnx", FileMode.Create)
' Save the report to the created file.
report.SaveDocument(stream)