RichEditDocumentServerExtensions.LoadDocumentAsync(RichEditDocumentServer, String, DocumentFormat, String, CancellationToken) Method
Asynchronously loads a document from a file in the specified format. External content for HTML format is retrieved from the specified source (base) URI.
Namespace: DevExpress.XtraRichEdit
Assembly: DevExpress.Docs.v24.2.dll
NuGet Package: DevExpress.Document.Processor
#Declaration
public static Task<bool> LoadDocumentAsync(
this RichEditDocumentServer self,
string filename,
DocumentFormat documentFormat,
string sourceUri,
CancellationToken cancellationToken
)
#Parameters
Name | Type | Description |
---|---|---|
self | Rich |
Current Rich |
filename | String | A string that specifies the file to load (including the full path). |
document |
Document |
The Document |
source |
String | The document URI. |
cancellation |
Cancellation |
A Cancellation |
#Returns
Type | Description |
---|---|
Task<Boolean> | A Task |
#Remarks
Important
The Rich
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 using the CancellationToken object:
private async void Convert2PdfWithCancellation()
{
//10 second limit
using (CancellationTokenSource source = new CancellationTokenSource(10000))
{
using (RichEditDocumentServer wordProcessor = new RichEditDocumentServer())
{
try
{
await wordProcessor.LoadDocumentAsync("test.html", DocumentFormat.Html, "test_files", source.Token); ;
await wordProcessor.ExportToPdfAsync("result.pdf");
}
catch (OperationCanceledException)
{
// Your code to handle cancellation
}
}
}
}