Workbook.SaveDocumentAsync(String, CancellationToken, IProgress<Int32>) Method

Asynchronously saves the document to a file (the file format is defined by the file extension). Allows you to implement progress notifications and cancel the operation.

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.v24.2.dll

NuGet Package: DevExpress.Document.Processor

Declaration

C#

public Task SaveDocumentAsync(
    string fileName,
    CancellationToken cancellationToken,
    IProgress<int> progress
)

VB.NET

Public Function SaveDocumentAsync(
    fileName As String,
    cancellationToken As CancellationToken,
    progress As IProgress(Of Integer)
) As Task

Parameters

Name	Type	Description
fileName	String	The file name (including the full path) for the output file.
cancellationToken	CancellationToken	A cancellation token that indicates whether to cancel the operation.
progress	IProgress<Int32>	An object used to report the task progress in percentage. Use a Progress<T> class instance to report progress.

Returns

Type	Description
Task	An object that defines the asynchronous save operation.

Remarks

The DocumentFormat enumeration lists the supported document formats. To export a file to PDF or HTML, use the Workbook.ExportToPdfAsync and Workbook.ExportToHtmlAsync methods.

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).

Example: Report Progress of Save Operation

The following example merges two workbooks and saves the result asynchronously. The console window displays the progress of the save operation. If this operation takes longer than 30 seconds, it is canceled.

C#

using System;
using System.Threading;
using System.Threading.Tasks;
using DevExpress.Spreadsheet;
// ...

static async Task Main(string[] args) {
    var cancellationSource = new CancellationTokenSource(TimeSpan.FromSeconds(30));
    var cancellationToken = cancellationSource.Token;
    try {
            using (Workbook workbook1 = new Workbook())
            {
                using (Workbook workbook2 = new Workbook())
                {
                    Console.WriteLine("Merging workbooks...");
                    await Task.WhenAll(new Task[]
                    {
                        workbook1.LoadDocumentAsync("Book1.xlsx"),
                        workbook2.LoadDocumentAsync("Book2.xlsx")
                    });
                    workbook1.Append(workbook2);
                    await workbook1.SaveDocumentAsync("MergedDocument.xlsx",
                        cancellationToken,
                        new Progress<int>((progress) => Console.WriteLine($"{progress}%")));
                    Console.WriteLine("Done!");
                }
            }
        }
    catch (OperationCanceledException) {
        Console.WriteLine("Cancelled by timeout.");
    }
    finally {
        cancellationSource.Dispose();
    }
}

VB.NET

Imports System
Imports System.Threading
Imports System.Threading.Tasks
Imports DevExpress.Spreadsheet

Module Example
    Sub Main()
        MainAsync().Wait()
    End Sub
    Async Function MainAsync() As Task
        Dim cancellationSource As New CancellationTokenSource(TimeSpan.FromSeconds(30))
        Dim cancellationToken As CancellationToken = cancellationSource.Token
        Try
            Using workbook1 As New Workbook()
                Using workbook2 As New Workbook()
                    Console.WriteLine("Merging workbooks...")
                    Await Task.WhenAll(New Task() { 
                        workbook1.LoadDocumentAsync("Book1.xlsx"), 
                        workbook2.LoadDocumentAsync("Book2.xlsx") })
                    workbook1.Append(workbook2)
                    Await workbook1.SaveDocumentAsync("MergedDocument.xlsx", cancellationToken, 
                        New Progress(Of Integer)(Sub(progress) Console.WriteLine($"{progress}%")))
                    Console.WriteLine("Done!")
                End Using
            End Using
        Catch e1 As OperationCanceledException
            Console.WriteLine("Cancelled by timeout.")
            Console.ReadLine()
        Finally
            cancellationSource.Dispose()
        End Try
    End Function
End Module

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.