DefaultWebDocumentViewerContainer.UseFileDocumentStorage(String) Method

Specifies a path for the report document’s file storage.

Namespace: DevExpress.XtraReports.Web.WebDocumentViewer

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

Declaration

C#

public static void UseFileDocumentStorage(
    string workingDirectory
)

VB.NET

Public Shared Sub UseFileDocumentStorage(
    workingDirectory As String
)

Parameters

Name	Type	Description
workingDirectory	String	Specifies a path to the directory where documents should be stored.

Remarks

To display a report, 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 a document. To avoid this, use a file storage for report documents. Call the UseFileDocumentStorage method to specify a path to the directory that the Document Viewer will use to get a document when the memory cache is empty.

The following code demonstrates how to use the UseFileDocumentStorage method, to specify a file storage for the Document Viewer.

C#

using DevExpress.XtraReports.Web.WebDocumentViewer;
//...
DefaultWebDocumentViewerContainer.UseFileDocumentStorage(Server.MapPath("~/App_Data/PreviewCache"));
//...

VB.NET

Imports DevExpress.XtraReports.Web.WebDocumentViewer
'...
DefaultWebDocumentViewerContainer.UseFileDocumentStorage(Server.MapPath("~/App_Data/PreviewCache"))
'...

Use the UseFileDocumentStorage(String, StorageSynchronizationMode) method overload to specify the InterProcess synchronization mode for the file storage if you use Web Farms or Garden. By default, the InterThread mode is set.

Note

If a viewed report includes interactive features, the Document Viewer uses the report’s instance to recreate the document. By default, the report instance is stored in memory. Specify a file storage to avoid problems with application pool recycling. For this purpose, use the UseFileReportStorage method.

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 documents whose lifetime exceeds a specific amount of time. If such documents are found, they are deleted. Call the UseEmptyStoragesCleaner() method to register an empty storage cleaner instead of the default one, so that documents 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.

JS

viewerModel().close();

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the UseFileDocumentStorage(String) 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-store-and-use-custom-document-data-in-the-Web-Document-Viewer/CS/CustomCachedDocumentSourceSerialization/Global.asax.cs#L11

DevExpress.XtraReports.Web.WebDocumentViewer.DefaultWebDocumentViewerContainer.RegisterSingleton<WebDocumentViewerOperationLogger, CustomWebDocumentViewerOperationLogger>();
DevExpress.XtraReports.Web.WebDocumentViewer.DefaultWebDocumentViewerContainer.UseFileDocumentStorage(Server.MapPath("~/App_Data/PreviewedDocuments/"));
ASPxWebDocumentViewer.StaticInitialize();

VB.NET

Reporting_How-to-store-and-use-custom-document-data-in-the-Web-Document-Viewer/VB/CustomCachedDocumentSourceSerialization/Global.asax.vb#L13

DevExpress.XtraReports.Web.WebDocumentViewer.DefaultWebDocumentViewerContainer.RegisterSingleton(Of WebDocumentViewerOperationLogger, CustomWebDocumentViewerOperationLogger)()
DevExpress.XtraReports.Web.WebDocumentViewer.DefaultWebDocumentViewerContainer.UseFileDocumentStorage(Server.MapPath("~/App_Data/PreviewedDocuments/"))
ASPxWebDocumentViewer.StaticInitialize()