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

Asynchronously saves the document to a byte array in the specified format. 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.v25.2.dll

NuGet Package : DevExpress.Document.Processor

csharp

public Task<byte[]> SaveDocumentAsync(
    DocumentFormat format,
    CancellationToken cancellationToken,
    IProgress<int> progress
)

Public Function SaveDocumentAsync(
    format As DocumentFormat,
    cancellationToken As CancellationToken,
    progress As IProgress(Of Integer)
) As Task(Of Byte())

Parameters

Name	Type	Description
format	DocumentFormat

An enumeration member that specifies the output document format.

| | 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<Byte[]>

Returns a byte array that contains document data in the specified format.

Remarks

You can use this SaveDocumentAsync method overload to store a workbook in an external database.

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.