officefileapi-devexpress-dot-spreadsheet-dot-workbook-dot-loaddocument-x28-system-dot-string-x29.md
Downloading documents passed into the LoadDocument method may create security issues. Review the following help topic and learn how to spot, analyze, and prohibit unwanted download requests:
Suppress Control Requests to Download Data from External URLs
Loads a document from a file.
You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.
Namespace : DevExpress.Spreadsheet
Assembly : DevExpress.Docs.v25.2.dll
NuGet Package : DevExpress.Document.Processor
public bool LoadDocument(
string fileName
)
Public Function LoadDocument(
fileName As String
) As Boolean
| Name | Type | Description |
|---|---|---|
| fileName | String |
A string that specifies a file to load (including the full path).
|
| Type | Description |
|---|---|
| Boolean |
true , if a document was loaded successfully; otherwise, false.
|
When you use this method to load a document from a file, the Spreadsheet automatically identifies the document’s format based on its content (regardless of filename extension).
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.
// Add a reference to the DevExpress.Docs.dll assembly.
using DevExpress.Spreadsheet;
// ...
Workbook workbook = new Workbook();
// Load a workbook from the file.
workbook.LoadDocument("Documents\\Document.xlsx");
' Add a reference to the DevExpress.Docs.dll assembly.
Imports DevExpress.Spreadsheet
' ...
Dim workbook As New Workbook()
' Load a workbook from the file.
workbook.LoadDocument("Documents\Document.xlsx")
The default calculation mode for a Workbook is Manual. This mode implies that the Spreadsheet does not recalculate formulas when you load a document. Call the Workbook.Calculate or Workbook.CalculateFull method to recalculate all formulas in the workbook.
using (Workbook workbook = new Workbook())
{
// Load a document.
// ...
// Calculate formulas in the document.
workbook.Calculate();
// ...
}
Using workbook As New Workbook()
' Load a document.
' ...
' Calculate formulas in the document.
workbook.Calculate()
' ...
End Using
Use the Workbook.Options.CalculationMode property to change the calculation mode for a Workbook.
The following calculation modes are available:
Manual (default) - Formulas are calculated only on demand (after the Calculate method call). It allows you to improve document generation speed for large workbooks with multiple formulas.
UseDocumentSettings - Uses the calculation mode specified in the loaded document (this value is stored in the Workbook.DocumentSettings.Calculation.Mode property).
Automatic - Recalculates formulas each time a cell value, formula, or defined name changes.
using (Workbook workbook = new Workbook())
{
// Change the calculation mode.
workbook.Options.CalculationMode = WorkbookCalculationMode.UseDocumentSettings;
// ...
// Load a document.
// ...
}
Using workbook As New Workbook()
' Change the calculation mode.
workbook.Options.CalculationMode = WorkbookCalculationMode.UseDocumentSettings
' ...
' Load a document.
' ...
End Using
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.
Workbook workbook = new DevExpress.Spreadsheet.Workbook();
workbook.LoadDocument("test1.xlsx");
{
wb.LoadDocument("..\\..\\..\\Employees.xlsx");
RangeDataSourceOptions options = new RangeDataSourceOptions();
asp-net-mvc-grid-upload-and-display-excel-file/CS/UploadControlApplication/Models/HelperClass.cs#L13
Workbook book = new Workbook();
book.LoadDocument(HomeControllerUploadControlSettings.resultFilePath);
Worksheet sheet = book.Worksheets.ActiveWorksheet;
office-file-api-create-thumbnail-images-for-docx-xlsx-pdf-files/CS/ImageExporterHelper.cs#L21
{
excelDocumentAPI.LoadDocument(fileName);
var worksheet = excelDocumentAPI.Worksheets.ActiveWorksheet;
spreadsheet-document-api-examples-part2/CS/SpreadsheetDocServerAPIPart2/Form1.cs#L78
workbook.Options.Culture = defaultCulture;
bool loaded = workbook.LoadDocument("Document.xlsx");
Debug.Assert(loaded);
spreadsheet-document-api-encryption/VB/EncryptionExample/Program.vb#L15
workbook.Options.Import.Password = "123"
workbook.LoadDocument("..\..\..\Documents\encrypted.xlsx")
AddHandler workbook.EncryptedFilePasswordRequest, AddressOf Workbook_EncryptedFilePasswordRequest
Dim workbook As Workbook = New Workbook()
workbook.LoadDocument("test1.xlsx")
Dim workbook2 As Workbook = New Workbook()
Using wb As Workbook = New Workbook()
wb.LoadDocument("..\..\..\Employees.xlsx")
Dim options As RangeDataSourceOptions = New RangeDataSourceOptions()
Dim workbook As New Workbook()
workbook.LoadDocument("TopTradingPartners.xlsx")
Dim worksheet As Worksheet = workbook.Worksheets(0)
asp-net-mvc-grid-upload-and-display-excel-file/VB/UploadControlApplication/Models/HelperClass.vb#L8
Dim book As New Workbook()
book.LoadDocument(HomeControllerUploadControlSettings.resultFilePath)
Dim sheet As Worksheet = book.Worksheets.ActiveWorksheet
See Also
How to: Load a Document to a Workbook