Workbook.SaveDocumentAsync(DocumentFormat, EncryptionSettings, CancellationToken) Method

Asynchronously saves the document to an array of bytes in the specified format and with the specified encryption settings.

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.1.dll

NuGet Package: DevExpress.Document.Processor

Declaration

C#

public Task<byte[]> SaveDocumentAsync(
    DocumentFormat format,
    EncryptionSettings encryptionSettings,
    CancellationToken cancellationToken
)

VB.NET

Public Function SaveDocumentAsync(
    format As DocumentFormat,
    encryptionSettings As EncryptionSettings,
    cancellationToken As CancellationToken
) As Task(Of Byte())

Parameters

Name	Type	Description
format	DocumentFormat	A DocumentFormat enumeration value that specifies the document’s format.
encryptionSettings	EncryptionSettings	Specifies encryption options.
cancellationToken	CancellationToken	A CancellationToken object used to trace the requests to cancel an operation.

Returns

Type	Description
Task<Byte[]>	A Task<TResult> object that returns a byte array with encrypted data in the specified format.

Remarks

This SaveDocument method overload can be used 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.