SpreadsheetControl.LoadDocument(String) Method

Loads a document from a file.

Namespace: DevExpress.XtraSpreadsheet

Assembly: DevExpress.XtraSpreadsheet.v24.1.dll

NuGet Package: DevExpress.Win.Spreadsheet

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 specifying the file to load (including the full path).

Returns

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

Remarks

The IWorkbook interface provides the equivalent method.

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

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) 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-load-and-save-a-password-encrypted-files/CS/EncryptionExample/Form1.cs#L39

spreadsheetControl1.Options.Import.Password = "123";
spreadsheetControl1.LoadDocument(documentName);
#endregion #OptionsImportPassword

winforms-spreadsheet-custom-draw-example/CS/WindowsFormsApp1/Form1.cs#L17

    // Load a document.
    spreadsheetControl1.LoadDocument("Products.xlsx");
}

winforms-spreadsheet-mail-merge/CS/DXApplication1/Form1.cs#L22

private void Form1_Load(object sender, System.EventArgs e) {
    spreadsheetControl1.LoadDocument("Documents\\MailMergeTemplate.xlsx");
    template = spreadsheetControl1.Document;

winforms-spreadsheet-control-create-a-data-entry-form/CS/DataEntryFormSample/MainForm.cs#L30

private void LoadDocumentTemplate() {
    spreadsheetControl1.LoadDocument("PayrollCalculatorTemplate.xlsx");
    spreadsheetControl1.Document.History.IsEnabled = false;

winforms-spreadsheet-use-cell-range-as-data-source/CS/RangeDataSource/Form1.cs#L14

InitializeComponent();
spreadsheetControl1.LoadDocument("temperature.xlsx");
ribbonControl1.SelectedPage = dataRibbonPage1;

VB.NET

winforms-spreadsheet-load-and-save-a-password-encrypted-files/VB/EncryptionExample/Form1.vb#L40

            spreadsheetControl1.Options.Import.Password = "123"
            spreadsheetControl1.LoadDocument(documentName)
#End Region  ' #OptionsImportPassword

winforms-spreadsheet-custom-draw-example/VB/CustomDrawExample/Form1.vb#L15

InitializeComponent()
spreadsheetControl1.LoadDocument("Products.xlsx")
spreadsheetControl1.Options.Behavior.Column.Delete = DocumentCapability.Disabled

winforms-spreadsheet-mail-merge/VB/DXApplication1/Form1.vb#L22

Private Sub Form1_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles MyBase.Load
    spreadsheetControl1.LoadDocument("Data\MailMergeTemplate.xlsx")
    template = spreadsheetControl1.Document

winforms-spreadsheet-control-create-a-data-entry-form/VB/DataEntryFormSample/MainForm.vb#L25

Private Sub LoadDocumentTemplate()
    spreadsheetControl1.LoadDocument("PayrollCalculatorTemplate.xlsx")
    spreadsheetControl1.Document.History.IsEnabled = False

winforms-spreadsheet-use-cell-range-as-data-source/VB/RangeDataSource/Form1.vb#L16

InitializeComponent()
spreadsheetControl1.LoadDocument("temperature.xlsx")
ribbonControl1.SelectedPage = dataRibbonPage1