Back to Devexpress

Document.LoadDocument(Byte[], DocumentFormat) Method

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

latest2.7 KB
Original Source

Document.LoadDocument(Byte[], DocumentFormat) Method

Loads a document in the specified format from a byte array.

Namespace : DevExpress.XtraRichEdit.API.Native

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

NuGet Package : DevExpress.RichEdit.Core

Declaration

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

Parameters

NameTypeDescription
bufferByte[]

A byte array that contains document data.

| | format | DocumentFormat |

An enumeration member that specifies the format of the loaded document.

|

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.

If a document has a different format than the format parameter specifies, 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