RichEditDocumentServer.LoadDocument(Byte[]) Method

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

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.RichEdit.v24.2.Core.dll

NuGet Package: DevExpress.RichEdit.Core

Declaration

C#

public bool LoadDocument(
    byte[] buffer
)

VB.NET

Public Function LoadDocument(
    buffer As Byte()
) As Boolean

Parameters

Name	Type	Description
buffer	Byte[]	A byte array that contains document data.

Returns

Type	Description
Boolean	true if the document was successfully loaded; otherwise, false.

Remarks

The RichEditDocumentServer uses the built-in IFormatDetectorService service implementation to detect the loaded document’s format. The following formats are detected:

• DOC, DOCM, DOTX, DOT, DOTM, DOCX, RTF, HTM, HTML, MHT, XML, FlatOpc, EPUB;

• ODT - non-encrypted files only.

If format detection fails, the RichEditDocumentServer.InvalidFormatException event fires.

Tip

Use the LoadDocument method overloads with explicit format definition to improve performance.

You can use this LoadDocument method overload to load a document stored in an external database.

C#

using DevExpress.XtraRichEdit;
// ...

RichEditDocumentServer wordProcessor = new RichEditDocumentServer()

// Save a document to a byte array to store it in a database.
byte[] docBytes = wordProcessor.SaveDocument(DocumentFormat.OpenXml);

// ...

// Load the saved document from a byte array.
wordProcessor.LoadDocument(docBytes);

VB.NET

Imports DevExpress.XtraRichEdit
' ...

Dim wordProcessor As New RichEditDocumentServer()

' Save a document to a byte array to store it in a database.
Dim docBytes() As Byte = wordProcessor.SaveDocument(DocumentFormat.OpenXml)

' ...

' Load the saved document from a byte array.
wordProcessor.LoadDocument(docBytes)

Tip

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.