DefaultWebDocumentViewerContainer.UseFileExportedDocumentStorage(String, StorageSynchronizationMode) Method

Specifies a path and synchronization mode for the exported document’s file storage.

Namespace: DevExpress.XtraReports.Web.WebDocumentViewer

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

Declaration

C#

public static void UseFileExportedDocumentStorage(
    string workingDirectory,
    StorageSynchronizationMode storageSynchronizationMode
)

VB.NET

Public Shared Sub UseFileExportedDocumentStorage(
    workingDirectory As String,
    storageSynchronizationMode As StorageSynchronizationMode
)

Parameters

Name	Type	Description
workingDirectory	String	Specifies a path to the directory where exported documents should be stored.
storageSynchronizationMode	StorageSynchronizationMode	Specifies a synchronization mode for the file storage.

Remarks

The Document Viewer uses a cache or file storage to get the exported document in the following cases:

• an asynchronous export mode is on explicitly;
• content editing is enabled in the exported document;
• when the Document Viewer displays a document from the Report and Dashboard Server.

By default, the exported document is stored in a memory cache and removed from it the first time it is requested. You can make the Document Viewer use a file storage instead. For this purpose, use the UseFileExportedDocumentStorage method.

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

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

C#

using DevExpress.XtraReports.Web.WebDocumentViewer;
//... 
  DefaultWebDocumentViewerContainer.UseFileExportedDocumentStorage(Server.MapPath("~/App_Data/PreviewCache"), StorageSynchronizationMode.InterProcess);
//...

VB.NET

Imports DevExpress.XtraReports.Web.WebDocumentViewer
'... 
  DefaultWebDocumentViewerContainer.UseFileExportedDocumentStorage(Server.MapPath("~/App_Data/PreviewCache"), StorageSynchronizationMode.InterProcess)
'... 

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 exported 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.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the UseFileExportedDocumentStorage(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.

C#

Reporting_how-to-use-the-web-report-designer-and-web-document-viewer-in-the-web-gardens-t528588/CS/DevExpressWebFarmsWebGardenReporting/Global.asax.cs#L13

protected void Application_Start(object sender, EventArgs e) {
    DefaultWebDocumentViewerContainer.UseFileExportedDocumentStorage(Server.MapPath("~/CustomSharedViewerStorage/ExportedDocuments"), StorageSynchronizationMode.InterProcess);
    DefaultWebDocumentViewerContainer.UseFileDocumentStorage(Server.MapPath("~/CustomSharedViewerStorage/Documents"), StorageSynchronizationMode.InterProcess);

VB.NET

Reporting_how-to-use-the-web-report-designer-and-web-document-viewer-in-the-web-gardens-t528588/VB/DevExpressWebFarmsWebGardenReporting/Global.asax.vb#L14

Protected Sub Application_Start(ByVal sender As Object, ByVal e As EventArgs)
    DefaultWebDocumentViewerContainer.UseFileExportedDocumentStorage(Server.MapPath("~/CustomSharedViewerStorage/ExportedDocuments"), StorageSynchronizationMode.InterProcess)
    DefaultWebDocumentViewerContainer.UseFileDocumentStorage(Server.MapPath("~/CustomSharedViewerStorage/Documents"), StorageSynchronizationMode.InterProcess)