Workbook.SaveDocumentAsync(Stream, DocumentFormat, CancellationToken) Method

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

NuGet Package: DevExpress.Document.Processor

Declaration

C#

public Task SaveDocumentAsync(
    Stream stream,
    DocumentFormat format,
    CancellationToken cancellationToken
)

VB.NET

Public Function SaveDocumentAsync(
    stream As Stream,
    format As DocumentFormat,
    cancellationToken As CancellationToken
) As Task

Parameters

Name	Type	Description
stream	Stream	Specifies the output stream.
format	DocumentFormat	A DocumentFormat enumeration value that specifies the document’s format.
cancellationToken	CancellationToken	A CancellationToken object used to trace the requests to cancel an operation.

Returns

Type	Description
Task	An asynchronous export operation.

Remarks

Take into account the following when you save a document to a stream:

• Do not save a workbook to a stream that does not support seek operations. An exception is thrown in this case. Use the System.IO.Stream.CanSeek property to determine if the steam supports seeking.

• Do not save a workbook to the same stream from which it was loaded. In this case, document bytes are written to the end of the existing stream and an invalid document is produced.

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.