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.2.dll
NuGet Package: DevExpress.Document.Processor
#Declaration
public static Task SaveDocumentAsync(
this RichEditDocumentServer self,
Stream stream,
DocumentFormat documentFormat,
EncryptionSettings encryptionSettings,
CancellationToken cancellationToken
)
#Parameters
Name | Type | Description |
---|---|---|
self | Rich |
The current Rich |
stream | Stream | The stream to which to output the document. |
document |
Document |
The enumeration value that indicates the document format. |
encryption |
Encryption |
An object that contains document encryption options. |
cancellation |
Cancellation |
A Cancellation |
#Returns
Type | Description |
---|---|
Task | An asynchronous export operation. |
#Remarks
Important
The Rich
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:
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);
}
}
}