ISpreadsheetComponent.LoadDocument(String) Method

Loads a document from a file.

Namespace: DevExpress.Spreadsheet

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

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

bool LoadDocument(
    string fileName
)

VB.NET

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

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

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-spreadsheetcontrol-api-part-2/CS/SpreadsheetControl_API_Part02/SpreadsheetActions/SearchActions.cs#L18

#region #SimpleSearch
workbook.LoadDocument("Documents\\ExpenseReport.xlsx");
workbook.Calculate();

winforms-spreadsheetcontrol-api-part-3/CS/SpreadsheetControl_API_Part03/CodeExamples/RowAndColumnActions.cs#L11

#region #DeleteRowsBasedOnCondition
workbook.LoadDocument("Documents\\Document.xlsx");
Worksheet worksheet = workbook.Worksheets[0];

spreadsheet-document-api-examples-part3/CS/Spreadsheet_Document_Api_Part_3/CodeExamples/RowAndColumnActions.cs#L12

// Load a document from a file.
workbook.LoadDocument("Documents\\Document.xlsx");

wpf-spreadsheet-chart-api/CS/SpreadsheetWPFChartAPISamples/MainWindow.xaml.cs#L74

workbook.Options.Culture = defaultCulture;
bool loaded = workbook.LoadDocument("Document.xlsx");
System.Diagnostics.Debug.Assert(loaded);

wpf-spreadsheet-pivot-table-api-examples/CS/SpreadsheetWPFPivotTableExamples/MainWindow.xaml.cs#L67

workbook.Options.Culture = defaultCulture;
bool loaded = workbook.LoadDocument("PivotTableTemplate.xlsx");
System.Diagnostics.Debug.Assert(loaded);

VB.NET

wpf-spreadsheetcontrol-api-part-2/VB/SpreadsheetControl_WPF_API_Part02/SpreadsheetActions/SearchActions.vb#L17

'            #Region "#SimpleSearch"
            workbook.LoadDocument("Documents\ExpenseReport.xlsx")
            workbook.Calculate()

winforms-spreadsheetcontrol-api-part-2/VB/SpreadsheetControl_API_Part02/SpreadsheetActions/SearchActions.vb#L15

'            #Region "#SimpleSearch"
            workbook.LoadDocument("Documents\ExpenseReport.xlsx")
            workbook.Calculate()

winforms-spreadsheetcontrol-api-part-3/VB/SpreadsheetControl_API_Part03/CodeExamples/RowAndColumnActions.vb#L10

#Region "#DeleteRowsBasedOnCondition"
            workbook.LoadDocument("Documents\Document.xlsx")
            Dim worksheet As DevExpress.Spreadsheet.Worksheet = workbook.Worksheets(0)

spreadsheet-document-api-examples-part3/VB/Spreadsheet_Document_Api_Part_3/CodeExamples/RowAndColumnActions.vb#L13

' Load a document from a file.
workbook.LoadDocument("Documents\Document.xlsx")

wpf-spreadsheet-chart-api/VB/SpreadsheetWPFChartAPISamples/MainWindow.xaml.vb#L78

workbook.Options.Culture = defaultCulture
Dim loaded As Boolean = workbook.LoadDocument("Document.xlsx")
System.Diagnostics.Debug.Assert(loaded)