RichEditDocumentServerExtensions.SaveDocumentAsync(RichEditDocumentServer, Stream, DocumentFormat, EncryptionSettings, CancellationToken) Method

Asynchronously saves the document to a stream with the specified document format and encryption options.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.Docs.v24.1.dll

NuGet Package: DevExpress.Document.Processor

Declaration

C#

public static Task SaveDocumentAsync(
    this RichEditDocumentServer self,
    Stream stream,
    DocumentFormat documentFormat,
    EncryptionSettings encryptionSettings,
    CancellationToken cancellationToken
)

VB.NET

<ExtensionAttribute>
Public Shared Function SaveDocumentAsync(
    self As RichEditDocumentServer,
    stream As Stream,
    documentFormat As DocumentFormat,
    encryptionSettings As EncryptionSettings,
    cancellationToken As CancellationToken
) As Task

Parameters

Name	Type	Description
self	RichEditDocumentServer	The current RichEditDocumentServer instance.
stream	Stream	The stream to which to output the document.
documentFormat	DocumentFormat	The enumeration value that indicates the document format.
encryptionSettings	EncryptionSettings	An object that contains document encryption options.
cancellationToken	CancellationToken	A CancellationToken object used to trace requests to cancel an operation.

Returns

Type	Description
Task	An asynchronous export operation.

Remarks

Important

The RichEditDocumentServerExtensions class is defined in the DevExpress.Docs.v24.1.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.

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

Handle the RichEditDocumentServer.BeforeExport event if the specified document format requires that a certain type of content should be saved as external objects. Use the HtmlDocumentExporterOptions.EmbedImages property to specify whether images are embedded in HTML code or a custom IUriProvider is used to construct src image references.

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

The code sample below merges two asynchronously loaded documents, and encrypts and exports the result:

C#

private async void MergeDocuments()
{
    using (CancellationTokenSource source = new CancellationTokenSource(10000))
    {
        using (RichEditDocumentServer wordProcessor = new RichEditDocumentServer())
        using (RichEditDocumentServer wordProcessor2 = new RichEditDocumentServer())
        {
            await Task.WhenAll(new Task[]
            {
          wordProcessor.LoadDocumentAsync("Document1.docx"),
          wordProcessor2.LoadDocumentAsync("Document2.docx")
            });

            EncryptionSettings encryptionSettings = new EncryptionSettings("12345", EncryptionType.Strong);
            wordProcessor.Document.AppendDocumentContent(wordProcessor2.Document.Range);
            await wordProcessor.SaveDocumentAsync(new FileStream("merged.docx", FileMode.Create, FileAccess.ReadWrite), 
                DocumentFormat.OpenXml, encryptionSettings, source.Token);
        }
    }
}

VB.NET

  Private Async Sub MergeDocuments()
    Using source As New CancellationTokenSource(10000)
      Using wordProcessor As New RichEditDocumentServer()
      Using wordProcessor2 As New RichEditDocumentServer()
        Await Task.WhenAll(New Task() { wordProcessor.LoadDocumentAsync("Document1.docx"), wordProcessor2.LoadDocumentAsync("Document2.docx") })

        Dim encryptionSettings As New EncryptionSettings("12345", EncryptionType.Strong)
        wordProcessor.Document.AppendDocumentContent(wordProcessor2.Document.Range)
        Await wordProcessor.SaveDocumentAsync(New FileStream("merged.docx", FileMode.Create, FileAccess.ReadWrite), DocumentFormat.OpenXml, encryptionSettings, source.Token)
      End Using
      End Using
    End Using
  End Sub