RichEditDocumentServerExtensions.LoadDocumentAsync(RichEditDocumentServer, Byte[]) Method

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

Assembly: DevExpress.Docs.v24.1.dll

NuGet Package: DevExpress.Document.Processor

Declaration

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

<ExtensionAttribute>
Public Shared Function LoadDocumentAsync(
    self As RichEditDocumentServer,
    buffer As Byte()
) As Task(Of Boolean)

Name	Type	Description
self	RichEditDocumentServer	The current RichEditDocumentServer instance.
buffer	Byte[]	A byte array that contains document data.

Type	Description
Task<Boolean>	Returns true if the document was loaded successfully; otherwise, false is returned.

Important

The RichEditDocumentServerExtensions class is defined in the DevExpress.Docs.v24.1.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).