Back to Devexpress

RichEditDocumentServer.LoadDocument(Byte[], DocumentFormat, String) Method

officefileapi-devexpress-dot-xtrarichedit-dot-richeditdocumentserver-dot-loaddocument-x28-system-dot-byte-devexpress-dot-xtrarichedit-dot-documentformat-system-dot-string-x29.md

latest2.8 KB
Original Source

RichEditDocumentServer.LoadDocument(Byte[], DocumentFormat, String) Method

Loads a document in the specified format from a byte array. You can use this method to load HTML documents with connected files.

Namespace : DevExpress.XtraRichEdit

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

NuGet Package : DevExpress.RichEdit.Core

Declaration

csharp
public bool LoadDocument(
    byte[] buffer,
    DocumentFormat format,
    string sourceUri
)
vb
Public Function LoadDocument(
    buffer As Byte(),
    format As DocumentFormat,
    sourceUri As String
) 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.

| | sourceUri | String |

The document’s URI. You can use this parameter to load files associated with an HTML document.

|

Returns

TypeDescription
Boolean

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

|

Remarks

If a document has a different format than the format parameter specifies, the RichEditDocumentServer.InvalidFormatException event fires.

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.

See Also

RichEditDocumentServer Class

RichEditDocumentServer Members

DevExpress.XtraRichEdit Namespace