Workbook.SaveDocumentAsync(String, CancellationToken) Method

Asynchronously saves the document to 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.v23.2.dll

NuGet Package: DevExpress.Document.Processor

Declaration

C#

public Task SaveDocumentAsync(
    string fileName,
    CancellationToken cancellationToken
)

VB.NET

Public Function SaveDocumentAsync(
    fileName As String,
    cancellationToken As CancellationToken
) As Task

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 following code sample shows how to merge two workbooks and save the result asynchronously.

C#

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");
  }
}

VB.NET

Private Async Sub MergeWorkbooks()
    Using workbook1 As Workbook = New Workbook()

        Using workbook2 As Workbook = New Workbook()
            Await Task.WhenAll(New Task() {workbook1.LoadDocumentAsync("book1.xlsx"), workbook2.LoadDocumentAsync("book2.xlsx")})
            workbook1.Append(workbook2)
            Await workbook1.SaveDocumentAsync("merged.xlsx")
        End Using
    End Using
End Sub

Important

Take into account the following when you call this method:

• The events fired by this method call may occur in a different thread than the target operation.

• The operation is not thread safe (the document should not be accessed simultaneously by different threads). Wait until the operation is completed before you continue to work with the document (for example, use the await operator).

Calculate Formulas Before Save Operation

The default calculation mode for a Workbook is Manual. This mode implies that the Spreadsheet does not calculate formulas before it saves a document. Call the Workbook.Calculate or Workbook.CalculateFull method to calculate all formulas in the workbook.