ISpreadsheetComponent.LoadDocument(String, DocumentFormat) Method

Loads a document from a file, specifying the document format.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v23.2.Core.dll

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

bool LoadDocument(
    string fileName,
    DocumentFormat format
)

VB.NET

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

Parameters

Name	Type	Description
fileName	String	A string specifying the file to load (including the full path).
format	DocumentFormat	One of the DocumentFormat members.

Returns

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

Example

Call the SpreadsheetControl.LoadDocument method with the file path to load a workbook from the existing file. Specify the file format as the second parameter of the method using the DocumentFormat enumerator.

View Example

Form1.cs

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

Form1.vb

' Load a workbook from a file.
spreadsheetControl1.LoadDocument("Documents\Document.xlsx", DocumentFormat.OpenXml)

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#

winforms-spreadsheet-apply-conditional-formatting-to-a-range-of-cells/CS/SpreadsheetControl/Form1.cs#L76

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

wpf-spreadsheet-bind-spreadsheet-to-ms-sql-server-database/CS/WpfSpreadsheet_BindToDataSource/MainWindow.xaml.cs#L35

// Load the template document into the SpreadsheetControl.
workbook.LoadDocument("Documents\\Suppliers_template.xlsx", DocumentFormat.Xlsx);
Worksheet sheet = workbook.Worksheets[0];

winforms-spreadsheetcontrol-api-part-2/CS/SpreadsheetControl_API_Part02/Form1.cs#L140

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

wpf-spreadsheet-how-to-apply-conditional-formatting-to-a-range-of-cells/CS/ConditionalFormatting_WPF_Examples/MainWindow.xaml.cs#L57

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

how-to-use-excel-add-ins-in-winforms-spreadsheet/CS/SpreadsheetAddIn/Form1.cs#L27

workbook = spreadsheetControl1.Document;
workbook.LoadDocument("Documents\\SphereMaterial.xlsx", DocumentFormat.OpenXml);
DefineCustomFunctions();

VB.NET

winforms-spreadsheet-apply-conditional-formatting-to-a-range-of-cells/VB/SpreadsheetControl/Form1.vb#L72

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

wpf-spreadsheet-bind-spreadsheet-to-ms-sql-server-database/VB/WpfSpreadsheet_BindToDataSource/MainWindow.xaml.vb#L36

' Load the template document into the SpreadsheetControl.
workbook.LoadDocument("Documents\Suppliers_template.xlsx", DocumentFormat.Xlsx)
Dim sheet As Worksheet = workbook.Worksheets(0)

winforms-spreadsheetcontrol-api-part-2/VB/SpreadsheetControl_API_Part02/Form1.vb#L135

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

wpf-spreadsheet-how-to-apply-conditional-formatting-to-a-range-of-cells/VB/ConditionalFormatting_WPF_Examples/MainWindow.xaml.vb#L52

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

how-to-use-excel-add-ins-in-winforms-spreadsheet/VB/SpreadsheetAddIn/Form1.vb#L26

workbook = spreadsheetControl1.Document
workbook.LoadDocument("Documents\SphereMaterial.xlsx", DocumentFormat.OpenXml)
DefineCustomFunctions()