Workbook.LoadDocumentAsync(String, DocumentFormat, CancellationToken) Method
Loads a document asynchronously in the specified format from a file.
Namespace: DevExpress.Spreadsheet
Assembly: DevExpress.Docs.v19.2.dll
Declaration
Parameters
Name | Type | Description |
---|---|---|
fileName | String | A string that specifies a file to load (including the full path). |
format | DocumentFormat | A DocumentFormat enumeration member that specifies the format of the loaded document. |
cancellationToken | CancellationToken | A CancellationToken object used to trace the requests to cancel an operation. |
Returns
Type | Description |
---|---|
Task<Boolean> | A Task<TResult> object that return true if the document was loaded successfully; otherwise, false. |
Remarks
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.
Important
Take into account the following when you call this method:
The events fired by this method’s call may occur in a different thread than the target operation.
The operation is not thread safe (documents should not be accessed simultaneously by different threads). Wait until the operation is completed before working with the document, i.e., use the
await
operator.