CachedReportSourceWeb Class
An object that acts as a mediator between a report and a Web Document Viewer.
Namespace: DevExpress.XtraReports.Web
Assembly: DevExpress.XtraReports.v19.2.Web.dll
NuGet Package: DevExpress.Web.Reporting.Common
Declaration
Related API Members
The following members return CachedReportSourceWeb objects:
Remarks
Use the CachedReportSourceWeb object to display a report in a Document Viewer. This object creates a report document and caches each generated page to a storage. Only pages displayed in a Document Viewer are stored in memory.
Pass a target report as a parameter to the CachedReportSourceWeb object’s constructor.
using DevExpress.XtraReports.Web;
using DevExpress.XtraPrinting.Caching;
//...
var cachedReportSource = new CachedReportSourceWeb(new XtraReport1());
A CachedReportSourceWeb object uses a MemoryDocumentStorage storage to cache a generated document. This storage stores a document in memory in a compact way. Use the UseFileExportedDocumentStorage (.NET Framework) / UseFileDocumentStorage (.NET Core) method to store the report documents in the File Document Storage instead. You can also use the DbDocumentStorage storage or implement a custom one. Register your IDocumentStorageProvider to manage document storages.
Display Large Reports
Use the OpenReport(String) (WebForms)) / Bind(String) (MVC) / Bind(String) (ASP.NET Core MVC) method to bind the Document Viewer to a report by the unique report name. Implement the ICachedReportSourceWebResolver interface to associate a report’s unique name with the CachedReportSourceWeb object that owns the report. A Document Viewer uses the ICachedReportSourceWebResolver object to find an appropriate CachedReportSourceWeb object by a report’s unique name and requests the found object to generate a report document, when required.
You can also use the OpenReport(CachedReportSourceWeb) (WebForms) / Bind(CachedReportSourceWeb) (MVC) method to directly bind a Document Viewer to the CachedReportSourceWeb object that owns a report . However, the report’s interactive features are only available to users until the application pool is recycled. The document needs to be regenerated to make interactive features available. However, after the application pool is recycled, the document cannot be regenerated, because the initial report cannot be found.
Merge Large Reports
When you merge large documents, use the CachedReportSourceWeb object’s CreateDocument() method to generate a document. Then use the XtraReport.ModifyDocument or CachedReportSourceWeb.ModifyDocument method to manipulate the generated document’s page set.
See the Merge Reports topic for more information on how to merge reports.
Limitations
The CachedReportSourceWeb component cannot be associated with reports that include a PrintableComponentContainer.
The Page.AddBrick method does not work if you use the CachedReportSource/CachedReportSourceWeb component to create report documents.
When you use the CachedReportSourceWeb component to generate a report document, the PrintOnPage event is raised each time a page with the current control is created. In this connection, the total number of pages is unknown at the moment the event fires and you cannot use the PageCount property in the event handler.
The RollPaper mode is not supported.
When you create a report document, the CachedReportSourceWeb component generates information for a single-file export. This increases memory consumption. Disable the AllowSingleFileExport option if you do not plan to export the generated document in single-file mode.