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

Asynchronously saves the document to a file in the specified format and encrypts the file with a password. 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.1.dll

NuGet Package: DevExpress.Document.Processor

Declaration

C#

public Task SaveDocumentAsync(
    string fileName,
    DocumentFormat format,
    EncryptionSettings encryptionSettings,
    CancellationToken cancellationToken,
    IProgress<int> progress
)

VB.NET

Public Function SaveDocumentAsync(
    fileName As String,
    format As DocumentFormat,
    encryptionSettings As EncryptionSettings,
    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.
format	DocumentFormat	An enumeration member that specifies the output document format.
encryptionSettings	EncryptionSettings	Specifies encryption settings.
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

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