Workbook.LoadDocument(String) 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 from a file.

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(
    string fileName
)

VB.NET

Public Function LoadDocument(
    fileName As String
) As Boolean

Parameters

Name	Type	Description
fileName	String	A string that specifies a file to load (including the full path).

Returns

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

Remarks

When you use this method to load a document from a file, the Spreadsheet automatically identifies the document’s format based on its content (regardless of filename extension).

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.

C#

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

Workbook workbook = new Workbook();

// Load a workbook from the file.
workbook.LoadDocument("Documents\\Document.xlsx");

VB.NET

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

Dim workbook As New Workbook()

' Load a workbook from the file.
workbook.LoadDocument("Documents\Document.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

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the LoadDocument(String) method.

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#

reporting-winforms-export-reports-to-diff-sheets-in-xlsx-file-with-spreadsheet-document-server/CS/WindowsFormsApplication1/Form1.cs#L38

Workbook workbook = new DevExpress.Spreadsheet.Workbook();
workbook.LoadDocument("test1.xlsx");

spreadsheet-document-api-export-worksheet-with-embedded-charts-to-pdf/CS/WorksheetChartsExportPDF/Program.cs#L21

workbook.LoadDocument("testDocument.xlsx");
workbook.ExportToPdf("resultingDocument.pdf");

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

workbook.Options.Culture = defaultCulture;
bool loaded = workbook.LoadDocument("Document.xlsx");
Debug.Assert(loaded);

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

workbook.Options.Culture = defaultCulture;
bool loaded = workbook.LoadDocument("PivotTableTemplate.xlsx");
Debug.Assert(loaded);

spreadsheet-document-api-use-worksheet-table-as-data-source/CS/SpreadsheetDocumentServerAsDataSourceExample/Form1.cs#L23

{
    wb.LoadDocument("Employees.xlsx");
    RangeDataSourceOptions options = new RangeDataSourceOptions();

VB.NET

reporting-winforms-export-reports-to-diff-sheets-in-xlsx-file-with-spreadsheet-document-server/VB/WindowsFormsApplication1/Form1.vb#L36

Dim workbook As Workbook = New Workbook()
workbook.LoadDocument("test1.xlsx")
Dim workbook2 As Workbook = New Workbook()

spreadsheet-document-api-encryption/VB/EncryptionExample/Program.vb#L15

workbook.Options.Import.Password = "123"
workbook.LoadDocument("Documents\encrypted.xlsx")
AddHandler workbook.EncryptedFilePasswordRequest, AddressOf Workbook_EncryptedFilePasswordRequest

spreadsheet-document-api-export-worksheet-with-embedded-charts-to-pdf/VB/WorksheetChartsExportPDF/Program.vb#L17

workbook.AddService(GetType(IChartImageService), New ChartImageService())
workbook.LoadDocument("testDocument.xlsx")
workbook.ExportToPdf("resultingDocument.pdf")

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

workbook.Options.Culture = defaultCulture
Dim loaded As Boolean = workbook.LoadDocument("Document.xlsx")
Debug.Assert(loaded)

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

workbook.Options.Culture = defaultCulture
Dim loaded As Boolean = workbook.LoadDocument("PivotTableTemplate.xlsx")
Debug.Assert(loaded)

Implements

LoadDocument(String)