DocumentManager.HibernationStoragePath Property

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

Namespace: DevExpress.Web.Office

Assembly: DevExpress.Web.v20.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 (EnableHibernation), 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

The following code example demonstrates how hibernation settings can be defined in the Application_Start method. Some of the settings are optional.

C#

<%@ Application Language="C#" %>
<%@ Import Namespace="DevExpress.Web.Office" %>
<script runat="server">
    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
    }
</script>

VB

<%@ Application Language="vb" %> 
<%@ Import Namespace="DevExpress.Web.Office" %>
<script runat="server">
    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
</script>