Workbook.LoadDocument(String, DocumentFormat) Method

Loads a document in the specified format from a file.

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

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Docs.v19.1.dll

Declaration

C#

public bool LoadDocument(
    string fileName,
    DocumentFormat format
)

VB.NET

Public Function LoadDocument(
    fileName As String,
    format As DocumentFormat
) As Boolean

Parameters

Name	Type	Description
fileName	String	A string that specifies a file to load (including the full path).
format	DocumentFormat	A DocumentFormat enumeration member that specifies the format of the loaded document.

Returns

Type	Description
Boolean	true, if a document was loaded successfully; 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 a loaded document.

Example

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", DocumentFormat.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", DocumentFormat.Xlsx)

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the LoadDocument(String, DocumentFormat) 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#

spreadsheet-document-api-apply-conditional-formatting-to-cell-range/CS/ConditionalFormatting_Example/Form1.cs#L72

// Load a workbook from a file.
workbook.LoadDocument("Documents\\Document.xlsx", DocumentFormat.OpenXml);
#endregion #LoadDocumentFromFile

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

// Load a workbook from the file.
workbook.LoadDocument("Documents\\Document.xlsx", DocumentFormat.OpenXml);
#endregion #LoadDocumentFromFile

VB.NET

spreadsheet-document-api-apply-conditional-formatting-to-cell-range/VB/ConditionalFormatting_Example/Form1.vb#L67

            ' Load a workbook from a file.
            workbook.LoadDocument("Documents\Document.xlsx", DocumentFormat.OpenXml)
'            #End Region ' #LoadDocumentFromFile

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

            ' Load a workbook from the file.
            workbook.LoadDocument("Documents\Document.xlsx", DocumentFormat.OpenXml)
'            #End Region ' #LoadDocumentFromFile

Implements

LoadDocument(String, DocumentFormat)