Skip to main content
All docs
V21.2

RichEditControl.LoadDocument(Byte[]) Method

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

Namespace: DevExpress.Xpf.RichEdit

Assembly: DevExpress.Xpf.RichEdit.v21.2.dll

Declaration

public bool LoadDocument(
    byte[] buffer
)

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.

See Also