DocumentManager.HibernateTimeout Property

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

Namespace: DevExpress.Web.Office

Assembly: DevExpress.Web.v21.1.dll

Declaration

public static TimeSpan HibernateTimeout { get; set; }

Property Value

Type Description
TimeSpan

An object that specifies the idle timeout. TimeSpan.FromHours(1) by default.

Remarks

When the document hibernation is enabled (EnableHibernation), 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

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

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