RichEditDocumentServerExtensions.SaveDocumentAsync(RichEditDocumentServer, String, DocumentFormat) Method
Asynchronously saves the document to a stream with the specified document format.
Namespace: DevExpress.XtraRichEdit
Assembly: DevExpress.Docs.v24.2.dll
NuGet Package: DevExpress.Document.Processor
Declaration
public static Task SaveDocumentAsync(
this RichEditDocumentServer self,
string fileName,
DocumentFormat documentFormat
)Parameters
| Name | Type | Description |
|---|---|---|
| self | RichEditDocumentServer | The current RichEditDocumentServer instance. |
| fileName | String | The path to the file to which to save the document. |
| documentFormat | DocumentFormat | The enumeration value that indicates the document format. |
Returns
| Type | Description |
|---|---|
| Task | An asynchronous export operation. |
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.
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
awaitoperator).
The code sample below merges two asynchronously loaded documents and asynchronously exports the result:
private async void MergeDocuments()
{
using (RichEditDocumentServer wordProcessor = new RichEditDocumentServer())
using (RichEditDocumentServer wordProcessor2 = new RichEditDocumentServer())
{
await Task.WhenAll(new Task[]
{
wordProcessor.LoadDocumentAsync("Document1.docx"),
wordProcessor2.LoadDocumentAsync("Document2.docx")
});
wordProcessor.AppendDocumentContent(wordProcessor2.Document.Range);
await wordProcessor.SaveDocumentAsync("merged.docx", DocumentFormat.OpenXml);
}
}
The code sample below merges two asynchronously loaded documents and exports the result:
private async void MergeDocuments()
{
using (RichEditDocumentServer wordProcessor = new RichEditDocumentServer())
using (RichEditDocumentServer wordProcessor2 = new RichEditDocumentServer())
{
await Task.WhenAll(new Task[]
{
wordProcessor.LoadDocumentAsync("Document1.docx"),
wordProcessor2.LoadDocumentAsync("Document2.docx")
});
wordProcessor.Document.AppendDocumentContent(wordProcessor2.Document.Range);
await wordProcessor.SaveDocumentAsync("merged.docx", DocumentFormat.OpenXml);
}
}