RichEditDocumentServerExtensions.LoadDocumentAsync(RichEditDocumentServer, Stream) Method
Asynchronously loads a document from a stream. The file format is determined by its content.
Namespace: DevExpress.XtraRichEdit
Assembly: DevExpress.Docs.v23.1.dll
NuGet Package: DevExpress.Document.Processor
Declaration
Parameters
Name | Type | Description |
---|---|---|
self | RichEditDocumentServer | Current RichEditDocumentServer instance. |
stream | Stream | The stream from which to load a document. |
Returns
Type | Description |
---|---|
Task<Boolean> | A Task<TResult> object that returns true if the document is successfully loaded; otherwise, false. |
Remarks
Important
The RichEditDocumentServerExtensions class is defined in the DevExpress.Docs.v23.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 format of the document loaded from a stream is detected automatically by the built-in IFormatDetectorService service implementation. The following formats are detected:
- DOC, DOCM, DOTX, DOT, DOTM, DOCX, RTF, HTM, HTML, MHT, XML, FlatOpc, EPUB;
- ODT - non-encrypted files only;
Plain text cannot be detected automatically. To load a plain text document, use another method override with DocumentFormat.PlainText as a parameter.
If the format detection fails or the passed string value is null, the RichEditDocumentServer.InvalidFormatException event fires.
After loading a document, the DocumentSaveOptions.CurrentFileName property is set to the file name and the DocumentSaveOptions.CurrentFormat property is set to the detected format.
Use the RichEditDocumentServer.DocumentLoaded event to determine the moment when the document model can be safely modified. Handle the DocumentLayout.DocumentFormatted event to check the loaded document layout.
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 asynchronously loads a document and exports it to the PDF format:
private async void Convert2Pdf()
{
using (RichEditDocumentServer wordProcessor = new RichEditDocumentServer())
{
try
{
await wordProcessor.LoadDocumentAsync(new FileStream("Document.docx", FileMode.Open));
await wordProcessor.ExportToPdfAsync("result.pdf");
}
catch (OperationCanceledException)
{
// Your code to handle cancellation
}
}
}