Skip to main content
All docs
V24.2

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

RichEditDocumentServerExtensions.LoadDocumentAsync(RichEditDocumentServer, Byte[]) Method

Asynchronously loads a document from a byte array. The file format is determined based on document content.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.Docs.v24.2.dll

NuGet Package: DevExpress.Document.Processor

#Declaration

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

#Parameters

Name Type Description
self RichEditDocumentServer

The current RichEditDocumentServer instance.

buffer Byte[]

A byte array that contains document data.

#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.v24.2.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 RichEditDocumentServer uses the built-in IFormatDetectorService service implementation to detect the loaded document’s format. If format detection fails, 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).

See Also