RichEditControl.LoadDocument(Byte[], DocumentFormat, String) 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 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.XtraRichEdit.v24.1.dll

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

Declaration

C#

public bool LoadDocument(
    byte[] buffer,
    DocumentFormat format,
    string sourceUri
)

VB.NET

Public Function LoadDocument(
    buffer As Byte(),
    format As DocumentFormat,
    sourceUri As String
) As Boolean

Parameters

Name	Type	Description
buffer	Byte[]	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

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

Remarks

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

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.