Workbook.LoadDocument(Byte[], DocumentFormat) Method

SECURITY NOTE

Downloading documents passed into the LoadDocument method may create security issues. Review the following help topic and learn how to spot, analyze, and prohibit unwanted download requests:

Suppress Control Requests to Download Data from External URLs

Loads a document in the specified format from a byte array.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Docs.v24.2.dll

NuGet Package: DevExpress.Document.Processor

Declaration

C#

public bool LoadDocument(
    byte[] buffer,
    DocumentFormat format
)

VB.NET

Public Function LoadDocument(
    buffer As Byte(),
    format As DocumentFormat
) As Boolean

Parameters

Name	Type	Description
buffer	Byte[]	A byte array that contains document data.
format	DocumentFormat	A DocumentFormat enumeration member that specifies the format of the loaded document.

Returns

Type	Description
Boolean	true, if the document was successfully loaded; otherwise, false.

Remarks

If you attempt to load a document in an incorrect format, the Workbook.InvalidFormatException event fires. To throw an exception when an invalid document is loaded, set the WorkbookImportOptions.ThrowExceptionOnInvalidDocument property to true (use the Workbook.Options.Import notation to access import options).

Handle the Workbook.DocumentLoaded event to determine when you can safely modify the loaded document.

You can use the current LoadDocument method overload to load a workbook stored in an external database. Refer to the How to: Store a Workbook in the Database document for more information.

C#

// Add a reference to the DevExpress.Docs.dll assembly.
using DevExpress.Spreadsheet;
// ...

Workbook workbook = new Workbook();

// Save a document to a byte array to store it in a database.
byte[] docBytes = workbook.SaveDocument(DocumentFormat.Xlsx);

// ...

// Load the saved document from a byte array into the Workbook instance.
workbook.LoadDocument(docBytes, DocumentFormat.Xlsx);

VB.NET

' Add a reference to the DevExpress.Docs.dll assembly.
Imports DevExpress.Spreadsheet
' ...

Dim workbook As New Workbook()

' Save a document to a byte array to store it in a database.
Dim docBytes() As Byte = workbook.SaveDocument(DocumentFormat.Xlsx)

' ...

' Load the saved document from a byte array into the Workbook instance.
workbook.LoadDocument(docBytes, DocumentFormat.Xlsx)

Calculate Formulas in the Loaded Document

The default calculation mode for a Workbook is Manual. This mode implies that the Spreadsheet does not recalculate formulas when you load a document. Call the Workbook.Calculate or Workbook.CalculateFull method to recalculate all formulas in the workbook.

C#

using (Workbook workbook = new Workbook())
{
    // Load a document.
    // ...
    // Calculate formulas in the document.
    workbook.Calculate();
    // ...
}

VB.NET

Using workbook As New Workbook()
    ' Load a document.
  ' ...
    ' Calculate formulas in the document.
    workbook.Calculate()
    ' ...
End Using

Change Calculation Mode

Use the Workbook.Options.CalculationMode property to change the calculation mode for a Workbook.

The following calculation modes are available:

• Manual (default) - Formulas are calculated only on demand (after the Calculate method call). It allows you to improve document generation speed for large workbooks with multiple formulas.

• UseDocumentSettings - Uses the calculation mode specified in the loaded document (this value is stored in the Workbook.DocumentSettings.Calculation.Mode property).

• Automatic - Recalculates formulas each time a cell value, formula, or defined name changes.

C#

using (Workbook workbook = new Workbook())
{
    // Change the calculation mode.
    workbook.Options.CalculationMode = WorkbookCalculationMode.UseDocumentSettings;
    // ...
    // Load a document.
    // ...
}

VB.NET

Using workbook As New Workbook()
  ' Change the calculation mode.
  workbook.Options.CalculationMode = WorkbookCalculationMode.UseDocumentSettings
  ' ...
  ' Load a document.
  ' ...
End Using

Implements

LoadDocument(Byte[], DocumentFormat)