SpreadsheetControl.LoadDocument(String, DocumentFormat) Method

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

Namespace: DevExpress.XtraSpreadsheet

Assembly: DevExpress.XtraSpreadsheet.v24.1.dll

NuGet Package: DevExpress.Win.Spreadsheet

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 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.

Remarks

The IWorkbook interface provides the equivalent method.

If the data you are trying to load has an incorrect format, the SpreadsheetControl.InvalidFormatException event fires. You can subscribe to this event and perform required actions to resolve this situation (for example, inform an end-user about the incorrect file). To throw an exception on loading an invalid document, set the WorkbookImportOptions.ThrowExceptionOnInvalidDocument property to true (import options are accessible via the SpreadsheetControl.Options.Import notation).

To determine the moment you can safely modify a loaded document, handle the SpreadsheetControl.DocumentLoaded event.

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-assign-custom-in-place-editors/CS/Spreadsheet_CustomCellEditors/Form1.cs#L13

InitializeComponent();
spreadsheetControl.LoadDocument("Documents\\Document.xlsx", DocumentFormat.Xlsx);

winforms-spreadsheetcontrol-api-part1/CS/SpreadsheetControl/Form1.cs#L133

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

VB.NET

winforms-spreadsheet-assign-custom-in-place-editors/VB/Spreadsheet_CustomCellEditors/Form1.vb#L13

InitializeComponent()
spreadsheetControl.LoadDocument("Documents\Document.xlsx", DocumentFormat.Xlsx)
AddHandler spreadsheetControl.DocumentLoaded, AddressOf spreadsheetControl1_DocumentLoaded

winforms-spreadsheetcontrol-api-part1/VB/SpreadsheetControl/Form1.vb#L127

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