RichEditControl.LoadDocument(Byte[]) Method

SECURITY NOTE

Downloading documents passed into the LoadDocument method may create security issues. Review the following help topic and learn how to spot, analyze, and prohibit unwanted download requests:

Suppress Control Requests to Download Data from External URLs

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

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v23.2.dll

NuGet Packages: DevExpress.Win.PivotGrid, DevExpress.Win.RichEdit, DevExpress.Win.TreeMap

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 RichEditControl 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 RichEditControl.InvalidFormatException event fires.

Tip

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

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

Tip

Use the RichEditControl.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.