DocumentManager.HibernationStoragePath Property

Specifies the path to the server directory to which documents are hibernated.

Namespace: DevExpress.Web.Office

Assembly: DevExpress.Web.v25.2.dll

NuGet Package: DevExpress.Web

Declaration

C#

public static string HibernationStoragePath { get; set; }

VB.NET

Public Shared Property HibernationStoragePath As String

Property Value

Type	Description
String	The path to the server directory.

Remarks

When the document hibernation is enabled (the EnableHibernation property is set to true), the DocumentManager hibernates inactive open documents after an idle timeout (HibernateTimeout) has passed.

Use the HibernationStoragePath property to specify the path to the server directory where documents are hibernated.

Example

Specify the hibernation settings in the Application_Start method handler in the global.asax file. In this instance, users are not required to reload the page with the Spreadsheet control and can continue to work with the open document even after a server failure.

The following code sample demonstrates how to define the hibernation settings:

Global.asax.cs

using DevExpress.Web.Office;

namespace YOUR_APP_ROOT_NAMESPACE {  
    public class Global_asax : System.Web.HttpApplication {  

        void Application_Start(object sender, EventArgs e) {  
            // Code that runs on application startup
            DocumentManager.HibernationStoragePath = Server.MapPath("~/App_Data/HibernationStorage/"); // Required setting
            DocumentManager.HibernateTimeout = TimeSpan.FromMinutes(30); // Optional setting
            DocumentManager.HibernatedDocumentsDisposeTimeout = TimeSpan.FromDays(1); // Optional setting
            DocumentManager.HibernateAllDocumentsOnApplicationEnd = true; // Optional setting
            DocumentManager.EnableHibernation = true; // Required setting to turn the hibernation on
        }  
    }  
}  

Global.asax.vb

Imports DevExpress.Web.Office

Namespace YOUR_APP_ROOT_NAMESPACE
    Public Class [Global]
        Inherits HttpApplication

        Private Sub Application_Start(ByVal sender As Object, ByVal e As EventArgs)
            ' Code that runs on application startup
            DocumentManager.HibernationStoragePath = Server.MapPath("~/App_Data/HibernationStorage/") ' Required setting
            DocumentManager.HibernateTimeout = TimeSpan.FromMinutes(30) ' Optional setting
            DocumentManager.HibernatedDocumentsDisposeTimeout = TimeSpan.FromDays(1) ' Optional setting
            DocumentManager.HibernateAllDocumentsOnApplicationEnd = True ' Optional setting
            DocumentManager.EnableHibernation = True ' Required setting to turn the hibernation on           
        End Sub
    End Class
End Namespace