XtraReport.SaveLayout(Stream) Method

Saves the report’s definition (layout and configuration) to a Stream object in the REPX data format.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v18.2.dll

Declaration

C#

public void SaveLayout(
    Stream stream
)

VB.NET

Public Sub SaveLayout(
    stream As Stream
)

Parameters

Name	Type	Description
stream	Stream	A Stream object to which the report’s definition will be saved.

Remarks

A report definition contains all report settings, as well as settings of report controls. To load the report’s definition from a REPX file, use the XtraReport.LoadLayout and XtraReport.FromStream methods.

Alternatively, to save a report definition in an XML format, use the XtraReport.SaveLayoutToXml.

To learn more, see Storing Report Layouts.

Example

This example demonstrates how to save a report definition to a stream (assigned to a corresponding ASP.NET Session) as a REPX file and restored back by using the XtraReport.SaveLayout and XtraReport.FromStream methods.

C#

using System.IO;
using DevExpress.XtraReports.UI;
// ...

private void StoreReport(XtraReport report) {
   // Create a stream.
   MemoryStream stream = new MemoryStream();

   // Save a report to the stream.
   report.SaveLayout(stream);

   // Save the stream to a session.
   Session["report_stream"] = stream;
}

private XtraReport RestoreReport() {
   // Restore the stream from the session.
   MemoryStream stream = (MemoryStream)Session["report_stream"];

   // Create a report from the stream.
   return XtraReport.FromStream(stream, true);
}

VB.NET

Imports System.IO
Imports DevExpress.XtraReports.UI
' ...

Private Sub StoreReport(report As XtraReport)
   ' Create a stream.
   Dim stream As New MemoryStream()

   ' Save a report to the stream.
   report.SaveLayout(stream)

   ' Save the stream to a session.
   Session("report_stream") = stream
End Sub

Private Function RestoreReport() As XtraReport
   ' Restore the stream from the session.
   Dim stream As MemoryStream = CType(Session("report_stream"), MemoryStream)

   ' Create a report from the stream.
   Return XtraReport.FromStream(stream, True)
End Function

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SaveLayout(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-winforms-custom-report-storage/CS/XpoReportStorage.cs#L62

using (MemoryStream stream = new MemoryStream()) {
    report.SaveLayout(stream);
    return stream.ToArray();

Reporting_how-to-integrate-the-web-report-designer-into-an-mvc-web-application-t190370/CS/DXWebApplication_ReportDesigner/CustomReportStorageWebExtension.cs#L52

MemoryStream ms = new MemoryStream();
report.SaveLayout(ms);
reportEntity.Layout = ms.ToArray();

Reporting_how-to-implement-a-custom-report-service-providing-report-documents-layouts-e4445/CS/HostApp/ReportService.cs#L26

report.SaveLayout(memoryStream);

Reporting_how-to-implement-an-immediate-preview-feature-in-the-end-user-designer-e1473/CS/Form1.cs#L46

report.SaveLayout(ms);
ms.Seek(0, SeekOrigin.Begin);

Reporting_wpf-end-user-report-designer-how-to-implement-a-report-storage-t292945/CS/WpfApplication38/Storages/DataSetFileStorage.cs#L134

{
    report.SaveLayout(stream);
    return stream.ToArray();

VB.NET

reporting-winforms-custom-report-storage/VB/XpoReportStorage.vb#L69

Using stream As New MemoryStream()
    report.SaveLayout(stream)
    Return stream.ToArray()

Reporting_how-to-integrate-the-web-report-designer-into-an-mvc-web-application-t190370/VB/DXWebApplication_ReportDesigner/CustomReportStorageWebExtension.vb#L54

Dim ms As New MemoryStream()
report.SaveLayout(ms)
reportEntity.Layout = ms.ToArray()

Reporting_how-to-implement-a-custom-report-service-providing-report-documents-layouts-e4445/VB/HostApp/ReportService.vb#L29

report.SaveLayout(memoryStream)

Reporting_how-to-implement-an-immediate-preview-feature-in-the-end-user-designer-e1473/VB/Form1.vb#L44

report.SaveLayout(ms)
ms.Seek(0, SeekOrigin.Begin)

Reporting_wpf-end-user-report-designer-how-to-implement-a-report-storage-t292945/VB/WpfApplication38/Storages/DataSetFileStorage.vb#L116

Using stream As New MemoryStream()
    report.SaveLayout(stream)
    Return stream.ToArray()