Workbook.SaveDocumentAsync(String, DocumentFormat, EncryptionSettings, CancellationToken) Method

SECURITY-RELATED CONSIDERATIONS

Using file paths sourced from untrusted input may expose unauthorized files or allow unintended file access. Always validate and normalize all external paths to prevent path manipulation.

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

NuGet Package : DevExpress.Document.Processor

Declaration

• C#
• VB.NET

public Task SaveDocumentAsync(
    string fileName,
    DocumentFormat format,
    EncryptionSettings encryptionSettings,
    CancellationToken cancellationToken
)

Public Function SaveDocumentAsync(
    fileName As String,
    format As DocumentFormat,
    encryptionSettings As EncryptionSettings,
    cancellationToken As CancellationToken
) As Task

Parameters

Specifies the file path to save the document.

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

An asynchronous export operation.

|

Remarks

Use this SaveDocumentAsync method overload to encrypt a workbook with a password.

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.

See Also

Workbook Class

Workbook Members

DevExpress.Spreadsheet Namespace