DocumentOptions.CalculationMode Property

Gets or sets the calculation mode that specifies when to calculate formulas in a Workbook or Spreadsheet control.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v26.1.Core.dll

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

[Browsable(false)]
public WorkbookCalculationMode CalculationMode { get; set; }

VB.NET

<Browsable(False)>
Public Property CalculationMode As WorkbookCalculationMode

Property Value

Type	Description
WorkbookCalculationMode	An enumeration member that specifies the calculation mode. The default is UseDocumentSettings for the WinForms and WPF Spreadsheet, and Manual for a Workbook component.

Available values:

Name	Description
UseDocumentSettings	Uses the calculation mode specified in the document (this value is stored in the CalculationOptions.Mode property).
Manual	Ignores the document’s calculation mode and starts calculation only on user request or after the Calculate method call. Never recalculates formulas when the document is loaded or before it is saved.
Automatic	Ignores the document’s calculation mode and recalculates formulas each time a cell value, formula, or defined name changes.

Property Paths

You can access this nested property as listed below:

Object Type	Path to CalculationMode
ISpreadsheetComponent	.Options .CalculationMode

Remarks

The CalculationMode property allows you to override the calculation mode of the loaded document (this setting is stored in the IWorkbook.DocumentSettings.Calculation.Mode property).

For instance, use Automatic mode for the Spreadsheet control if it should recalculate all dependent formulas every time a value, formula, or name referenced in these formulas changes.

C#

spreadsheetControl1.Options.CalculationMode = WorkbookCalculationMode.Automatic;

VB.NET

spreadsheetControl1.Options.CalculationMode = WorkbookCalculationMode.Automatic

Use Manual mode for a non-visual Workbook to improve document generation speed for large workbooks with multiple formulas. Call the Workbook.Calculate, Worksheet.Calculate, or CellRange.Calculate method to calculate formulas in the document.

C#

using (Workbook workbook = new Workbook())
{
    // Disable automatic calculations.
    workbook.Options.CalculationMode = WorkbookCalculationMode.Manual;
    // ...
    // Generate the document content.
    // ...
    // Perform calculations if needed.
    workbook.Calculate();
}

VB.NET

Using workbook As New Workbook()
  ' Disable automatic calculations.
  workbook.Options.CalculationMode = WorkbookCalculationMode.Manual
  ' ...
  ' Generate the document content.
  ' ...
  ' Perform calculations if needed.
  workbook.Calculate()
End Using

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the CalculationMode property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

spreadsheet-document-api-examples-part1/CS/SpreadsheetExamples/Form1.cs#L18

    InitTreeListControl();
    workbook.Options.CalculationMode = WorkbookCalculationMode.Automatic;
}

spreadsheet-document-api-pivot-table-examples/CS/SpreadsheetDocServerPivotAPI/Form1.cs#L22

    InitTreeListControl();
    workbook.Options.CalculationMode = WorkbookCalculationMode.Automatic;
}

spreadsheet-document-api-chart-examples/CS/SpreadsheetDocServerChartAPISamples/Form1.cs#L27

    InitTreeListControl();
    workbook.Options.CalculationMode = WorkbookCalculationMode.Automatic;
}

spreadsheet-document-api-examples-part2/CS/SpreadsheetDocServerAPIPart2/Form1.cs#L18

    InitTreeListControl();
    workbook.Options.CalculationMode = WorkbookCalculationMode.Automatic;
}

VB.NET

spreadsheet-document-api-examples-part1/VB/SpreadsheetExamples/Form1.vb#L19

    InitTreeListControl()
    workbook.Options.CalculationMode = WorkbookCalculationMode.Automatic
End Sub

spreadsheet-document-api-pivot-table-examples/VB/SpreadsheetDocServerPivotAPI/Form1.vb#L21

    InitTreeListControl()
    workbook.Options.CalculationMode = WorkbookCalculationMode.Automatic
End Sub

spreadsheet-document-api-chart-examples/VB/SpreadsheetDocServerChartAPISamples/Form1.vb#L22

    InitTreeListControl()
    workbook.Options.CalculationMode = WorkbookCalculationMode.Automatic
End Sub

spreadsheet-document-api-examples-part2/VB/SpreadsheetDocServerAPIPart2/Form1.vb#L17

    InitTreeListControl()
    workbook.Options.CalculationMode = WorkbookCalculationMode.Automatic
End Sub