RichEditDocumentServerExtensions.LoadDocumentAsync(RichEditDocumentServer, Byte[], DocumentFormat, String, CancellationToken) Method

Asynchronously loads a document in the specified format from a byte array. You can use this method to load HTML documents with connected files.

Namespace : DevExpress.XtraRichEdit

Assembly : DevExpress.Docs.v25.2.dll

NuGet Package : DevExpress.Document.Processor

csharp

public static Task<bool> LoadDocumentAsync(
    this RichEditDocumentServer self,
    byte[] buffer,
    DocumentFormat documentFormat,
    string sourceUri,
    CancellationToken cancellationToken
)

<ExtensionAttribute>
Public Shared Function LoadDocumentAsync(
    self As RichEditDocumentServer,
    buffer As Byte(),
    documentFormat As DocumentFormat,
    sourceUri As String,
    cancellationToken As CancellationToken
) As Task(Of Boolean)

Parameters

Name	Type	Description
self	RichEditDocumentServer

The current RichEditDocumentServer instance.

| | buffer | Byte[] |

A byte array that contains document data.

| | documentFormat | DocumentFormat |

An enumeration member that specifies the format of the loaded document.

| | sourceUri | String |

The document’s URI. You can use this parameter to load files associated with an HTML document.

| | cancellationToken | CancellationToken |

A cancellation token that indicates whether to cancel the operation.

Returns

Type	Description
Task<Boolean>

Returns true if the document was loaded successfully; otherwise, false is returned.

Remarks

Important

The RichEditDocumentServerExtensions class is defined in the DevExpress.Docs.v25.2.dll assembly and DevExpress.Document.Processor NuGet package. Add this assembly or package 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.

If a document has a different format than the documentFormat parameter specifies, the RichEditDocumentServer.InvalidFormatException event fires.

Use the RichEditDocumentServer.DocumentLoaded event to determine when you can safely modify the document model. Handle the DocumentLayout.DocumentFormatted event to check document layout-related data and objects.

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).