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, Byte[], DocumentFormat) Method

Asynchronously loads a document in the specified format from a byte array.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.Docs.v20.2.dll

Declaration

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

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.

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

See Also