SpreadsheetOptionsExtensions.AddHibernation(SpreadsheetOptions, Action<HibernationOptions>) Method

Sets hibernation options for Spreadsheet.

Namespace: DevExpress.AspNetCore

Assembly: DevExpress.AspNetCore.Spreadsheet.v24.1.dll

NuGet Package: DevExpress.AspNetCore.Spreadsheet

Declaration

public static SpreadsheetOptions AddHibernation(
    this SpreadsheetOptions spreadsheetOptions,
    Action<HibernationOptions> setupHibernation
)

Parameters

Name	Type	Description
spreadsheetOptions	SpreadsheetOptions	Spreadsheet options.
setupHibernation	Action<HibernationOptions>	A function that configures hibernation options.

Returns

Type	Description
SpreadsheetOptions	An object that can be used to further configure the Spreadsheet options.

Remarks

The example below demonstrates how to configure hibernation options:

Program.cs

builder.Services.AddSingleton<IHttpContextAccessor, HttpContextAccessor>();
builder.Services.AddDevExpressControls(options => {
    options.AddSpreadsheet(
        spreadsheetOptions => {
            spreadsheetOptions
                .AddHibernation( hibernationOptions => {
                    hibernationOptions.StoragePath = Path.Combine(builder.Environment.ContentRootPath, "HibernationStorage");
                    hibernationOptions.Timeout = TimeSpan.FromMinutes(20);
                    hibernationOptions.DocumentsDisposeTimeout = TimeSpan.FromDays(1);
                    hibernationOptions.AllDocumentsOnApplicationEnd = true;
                });
        }
    );
});