DocumentManager.EnableHibernation Property

Specifies whether the document work session hibernation is enabled.

Namespace: DevExpress.Web.Office

Assembly: DevExpress.Web.v24.2.dll

Declaration

C#

[DefaultValue(false)]
public static bool EnableHibernation { get; set; }

VB.NET

<DefaultValue(False)>
Public Shared Property EnableHibernation As Boolean

Property Value

Type	Default	Description
Boolean	false	true, if hibernation is enabled; otherwise, false.

Remarks

The DocumentManager can release server memory from inactive open documents and save them to the server file system. This behavior reduces server memory consumption and prevents the loss of unsaved document changes after IIS recycling. If a user interacts with a hibernated document, DocumentManager restores the document from the file system to the server’s RAM.

Set the EnableHibernation property to true to enable document hibernation.

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

<%@ 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>

global.asax.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>