RichEditDocumentServerExtensions.SaveDocumentAsync(RichEditDocumentServer, DocumentFormat, CancellationToken) Method

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

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.Docs.v24.2.dll

NuGet Package: DevExpress.Document.Processor

Declaration

C#

public static Task<byte[]> SaveDocumentAsync(
    this RichEditDocumentServer self,
    DocumentFormat documentFormat,
    CancellationToken cancellationToken
)

VB.NET

<ExtensionAttribute>
Public Shared Function SaveDocumentAsync(
    self As RichEditDocumentServer,
    documentFormat As DocumentFormat,
    cancellationToken As CancellationToken
) As Task(Of Byte())

Parameters

Name	Type	Description
self	RichEditDocumentServer	The current RichEditDocumentServer instance.
documentFormat	DocumentFormat	An enumeration member that specifies the output document format.
cancellationToken	CancellationToken	A cancellation token that indicates whether to cancel the operation.

Returns

Type	Description
Task<Byte[]>	Returns a byte array that contains data in the specified format.

Remarks

Important

The RichEditDocumentServerExtensions class is defined in the DevExpress.Docs.v24.2.dll assembly. Add this assembly to your project to use the RichEditDocumentServerExtensions members. You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this library in production code.

You can use this SaveDocumentAsync method overload to store a document in an external database. Handle the RichEditDocumentServer.BeforeExport event to specify export options.

The SaveDocumentAsync method call does not change the RichEditDocumentServer.Modified property value.

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