Workbook.SaveDocumentAsync(String, CancellationToken) Method
Asynchronously saves the document to a file.
You need a license to the DevExpress Office File API or DevExpress Universal Subscription to use this method in production code.
Namespace: DevExpress.Spreadsheet
Assembly: DevExpress.Docs.v19.2.dll
Declaration
Parameters
Name | Type | Description |
---|---|---|
fileName | String | Specifies the file path to save the document. |
cancellationToken | CancellationToken | A CancellationToken object used to trace the requests to cancel an operation. |
Returns
Type | Description |
---|---|
Task | An asynchronous export operation. |
Remarks
The DocumentFormat enumeration lists the supported document formats. To export a file to PDF or HTML, use the Workbook.ExportToPdf and Workbook.ExportToHtml methods.
The code sample below shows how to merge two asynchronously loaded workbooks and save the result asynchronously.
private async void MergeWorkbooks()
{
using (Workbook workbook1 = new Workbook())
using (Workbook workbook2 = new Workbook())
{
await Task.WhenAll(new Task[]
{
workbook1.LoadDocumentAsync("book1.xlsx"),
workbook2.LoadDocumentAsync("book2.xlsx")
});
workbook1.Append(workbook2);
await workbook1.SaveDocumentAsync("merged.xlsx");
}
}
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.