DocumentManager.HibernateTimeout Property
Specifies the idle timeout after which an open document is hibernated.
Namespace: DevExpress.Web.Office
Assembly: DevExpress.Web.v25.2.dll
NuGet Package: DevExpress.Web
Declaration
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:
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
}
}
}