DefaultWebDocumentViewerContainer.UseFileReportStorage(String, StorageSynchronizationMode) Method
Specifies a path and synchronization mode for the report’s file storage.
Namespace: DevExpress.XtraReports.Web.WebDocumentViewer
Assembly: DevExpress.XtraReports.v18.2.Web.dll
Declaration
public static void UseFileReportStorage(
string workingDirectory,
StorageSynchronizationMode storageSynchronizationMode
)Parameters
| Name | Type | Description |
|---|---|---|
| workingDirectory | String | Specifies a path to the directory where report xml should be stored. |
| storageSynchronizationMode | StorageSynchronizationMode | Specifies a synchronization mode for the file storage. |
Remarks
To display a report from the Web Report Designer, the Web Document Viewer generates a report document. By default, documents are stored in a memory cache. This is not a stable storage because the application pool can be recycled when the memory usage reaches a specified limit, idle session closes or a scheduled cache cleaning runs. This all leads to the document’s deletion from the memory cache and the inability of the Document Viewer to display the document. To avoid this, provide a file storage for documents using the UseFileDocumentStorage method.
If a report includes interactive features, the Document Viewer recreates the document using the report instance that is stored in memory by default. Use the UseFileReportStorage method to specify a path to the directory to which the result of report xml serialization will be saved and which the Document Viewer will use to recreate the document when the memory cache is empty.
Specify the InterProcess synchronization mode for the file storage if you use Web Farms or Garden (by default, the InterThread mode is set). For this purpose, call the UseFileReportStorage(workingDirectory, storageSynchronizationMode) method overload.
The following code demonstrates how to use the UseFileReportStorage method, to specify a file storage for the Document Viewer.
using DevExpress.XtraReports.Web.WebDocumentViewer;
//...
DefaultWebDocumentViewerContainer.UseFileReportStorage(Server.MapPath("~/App_Data/PreviewCache"), StorageSynchronizationMode.InterProcess);
//...
Tip
The file storage that you specify using the UseFileReportStorage method is also used by the Document Viewer when it is invoked by the OpenReport(XtraReport) method. We recommend that you use the OpenReport(String) method overload instead to not provide additional file storage with report xml. Implement the IWebDocumentViewerReportResolver interface to associate the passed string value with a specific XtraReport instance.
According to the time settings specified in the CacheCleanerSettings and StorageCleanerSettings classes, the default cleaner service periodically checks if the cache and file storage contain reports whose lifetime exceeds a specific amount of time. If such reports are found, they are deleted. Call the UseEmptyStoragesCleaner() method to register an empty storage cleaner instead of the default one, so that reports are not removed automatically.
To force cache clearing, use the following code (where “viewer” corresponds to the client instance name of the Document Viewer). Note that due to Garbage Collector specifics, disposing of a report does not guarantee immediate memory release.
viewer.close();
Related GitHub Examples
The following code snippet (auto-collected from DevExpress Examples) contains a reference to the UseFileReportStorage(String, StorageSynchronizationMode) 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.