Workbook.LoadDocument(Stream, DocumentFormat) Method

Loads a document in the specified format from a stream.

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(
    Stream stream,
    DocumentFormat format
)

VB.NET

Public Function LoadDocument(
    stream As Stream,
    format As DocumentFormat
) As Boolean

Parameters

Name	Type	Description
stream	Stream	The stream from which to load a document.
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 the loaded document.

C#

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

Workbook workbook = new Workbook();

// Load a workbook from the stream.
using (FileStream stream = new FileStream("Documents\\Document.xlsx", FileMode.Open)) {
    workbook.LoadDocument(stream, DocumentFormat.Xlsx);
}

VB.NET

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

Dim workbook As New Workbook()

' Load a workbook from the stream.
Using stream As New FileStream("Documents\Document.xlsx", FileMode.Open)
    workbook.LoadDocument(stream, DocumentFormat.Xlsx)
End Using

The LoadDocument method can use a non-seekable stream to load a document. In this case, the stream is copied to a memory stream for further processing.

Note

If you use the DocumentFormat.Undefined value as the method’s format parameter, the document’s format is detected automatically.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the LoadDocument(Stream, 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#

how-to-export-mvc-spreadsheet-extension-to-pdf-using-workbook-component-t157548/CS/DXWebApplication24/Controllers/HomeController.cs#L36

Workbook docServer = new Workbook();
docServer.LoadDocument(ms, DocumentFormat.Xlsm);
ms.Position = 0;

VB.NET

how-to-export-mvc-spreadsheet-extension-to-pdf-using-workbook-component-t157548/VB/DXWebApplication24/Controllers/HomeController.vb#L38

Dim docServer As New Workbook()
docServer.LoadDocument(ms, DocumentFormat.Xlsm)
ms.Position = 0

Implements

LoadDocument(Stream, DocumentFormat)