Workbook.SaveDocumentAsync(String, DocumentFormat, CancellationToken) Method
Asynchronously saves the document to a file in the specified document format.
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. |
format | DocumentFormat | A DocumentFormat enumeration value that specifies the document’s format. |
cancellationToken | CancellationToken | A CancellationToken object used to trace the requests to cancel an operation. |
Returns
Type | Description |
---|---|
Task | An asynchronous export operation. |
Remarks
Use the Workbook.Options.Export
property or Workbook.BeforeExport event to specify export options.
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.