All docs
V20.2
21.1 (EAP/Beta)
20.2
20.1
The page you are viewing does not exist in version 20.1. This link will take you to the root page.
19.2
The page you are viewing does not exist in version 19.2. This link will take you to the root page.
19.1
The page you are viewing does not exist in version 19.1. This link will take you to the root page.
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.
.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+

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.v20.2.dll

Declaration

public static Task<bool> LoadDocumentAsync(
    this RichEditDocumentServer self,
    string filename,
    DocumentFormat documentFormat,
    string sourceUri,
    CancellationToken cancellationToken
)

Parameters

Name Type Description
self RichEditDocumentServer

Current RichEditDocumentServer instance.

filename String

A string that specifies the file to load (including the full path).

documentFormat DocumentFormat

The DocumentFormat enumeration member that indicates the document format.

sourceUri String

The document URI.

cancellationToken CancellationToken

A CancellationToken object used to trace requests to cancel an operation.

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.v20.2.dll assembly. Add this assembly to your project to use the RichEditDocumentServerExtensions members. You need an active license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this library in production code.

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's call may occur in a different thread than the target operation.

  • The operation is not thread safe (documents should not be accessed simultaneously by different threads). Wait until the operation is completed before working with the document, i.e., 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
            }
        }
    }
}
See Also