Workbook.SaveDocumentAsync(DocumentFormat) Method

Asynchronously saves the document to a byte array in the specified document format.

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#

public Task<byte[]> SaveDocumentAsync(
    DocumentFormat format
)

VB.NET

Public Function SaveDocumentAsync(
    format As DocumentFormat
) As Task(Of Byte())

Parameters

Name	Type	Description
format	DocumentFormat	A DocumentFormat enumeration value that specifies the document’s format.

Returns

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

Remarks

You can use the current 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.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the SaveDocumentAsync(DocumentFormat) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

spreadsheet-document-api-create-loan-amortization-schedule-within-blazor-server-app/CS/BlazorAppSpreadsheet/Code/DocumentService.cs#L32

    // Save the document as XLSX.
    return await workbook.SaveDocumentAsync(DocumentFormat.Xlsx);
}