CacheReportDocumentEventArgs.SaveDocumentToMemoryStream() Method

Saves the current document to a memory stream.

Namespace: DevExpress.XtraReports.Web

Assembly: DevExpress.XtraReports.v18.2.Web.WebForms.dll

Declaration

C#

public MemoryStream SaveDocumentToMemoryStream()

VB.NET

Public Function SaveDocumentToMemoryStream As MemoryStream

Returns

Type	Description
MemoryStream	A MemoryStream object, which contains the saved document as a byte array.

Remarks

The SaveDocumentToMemoryStream method is intended to implement caching a web report.

To accomplish this task, you need to handle the ReportViewer.CacheReportDocument event, and if a report document is already generated, save it to a memory stream via the SaveDocumentToMemoryStream method. Then, you need to handle the ReportViewer.RestoreReportDocumentFromCache event, and if the document is already stored in cache, restore it via the RestoreReportDocumentFromCacheEventArgs.RestoreDocumentFromStream method.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SaveDocumentToMemoryStream() 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-bind-a-web-report-to-a-collection-of-custom-objects-at-design-time-e1936/CS/ShowReport/Default.aspx.cs#L44

protected void ASPxDocumentViewer1_CacheReportDocument(object sender, DevExpress.XtraReports.Web.CacheReportDocumentEventArgs e) {
    Page.Session["report"] = e.SaveDocumentToMemoryStream();
}

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

protected void ASPxDocumentViewer1_CacheReportDocument(object sender, CacheReportDocumentEventArgs e) {
    using (System.IO.MemoryStream ms =e.SaveDocumentToMemoryStream()){
        Session["Report"] = ms.ToArray();

VB.NET

Reporting_how-to-bind-a-web-report-to-a-collection-of-custom-objects-at-design-time-e1936/VB/ShowReport/Default.aspx.vb#L46

Protected Sub ASPxDocumentViewer1_CacheReportDocument(ByVal sender As Object, ByVal e As DevExpress.XtraReports.Web.CacheReportDocumentEventArgs)
    Page.Session("report") = e.SaveDocumentToMemoryStream()
End Sub

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

Protected Sub ASPxDocumentViewer1_CacheReportDocument(ByVal sender As Object, ByVal e As CacheReportDocumentEventArgs)
    Using ms As System.IO.MemoryStream =e.SaveDocumentToMemoryStream()
        Session("Report") = ms.ToArray()