DocumentManager.HibernateTimeout Property

Specifies the idle timeout after which an open document is hibernated.

Namespace: DevExpress.Web.Office

Assembly: DevExpress.Web.v24.1.dll

NuGet Package: DevExpress.Web

Declaration

C#

public static TimeSpan HibernateTimeout { get; set; }

VB.NET

Public Shared Property HibernateTimeout As TimeSpan

Property Value

Type	Default	Description
TimeSpan	TimeSpan.FromHours(1)	An object that specifies the idle timeout.

Remarks

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

The HibernatedDocumentsDisposeTimeout property specifies how long hibernated documents are stored on the server before disposal.

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>