Back to Devexpress

Document.LoadDocument(Byte[]) Method

officefileapi-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-document-dot-loaddocument-x28-system-dot-byte-x29.md

latest2.7 KB
Original Source

Document.LoadDocument(Byte[]) Method

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

Namespace : DevExpress.XtraRichEdit.API.Native

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

NuGet Package : DevExpress.RichEdit.Core

Declaration

csharp
bool LoadDocument(
    byte[] buffer
)
vb
Function LoadDocument(
    buffer As Byte()
) As Boolean

Parameters

NameTypeDescription
bufferByte[]

A byte array that contains document data.

|

Returns

TypeDescription
Boolean

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

|

Remarks

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

The built-in IFormatDetectorService service implementation is used 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 InvalidFormatException event fires.

Tip

Use the RichEditDocumentServer.DocumentLoaded, RichEditControl.DocumentLoaded (WinForms), or RichEditControl.DocumentLoaded (WPF) 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

Document Interface

Document Members

DevExpress.XtraRichEdit.API.Native Namespace