RichEditControl.LoadDocument(Stream, DocumentFormat, Boolean) 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 from a stream, specifying the document format and optionally leaving the stream open.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v24.1.dll

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

Declaration

C#

public virtual bool LoadDocument(
    Stream stream,
    DocumentFormat documentFormat,
    bool leaveOpen
)

VB.NET

Public Overridable Function LoadDocument(
    stream As Stream,
    documentFormat As DocumentFormat,
    leaveOpen As Boolean
) As Boolean

Parameters

Name	Type	Description
stream	Stream	The stream from which to load a document.
documentFormat	DocumentFormat	One of the DocumentFormat enumeration members indicating the document format.
leaveOpen	Boolean	true, to leave the stream open; otherwise, false.

Returns

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

Remarks

The source stream can be non-seekable. In this case, the stream is buffered automatically.

If the document is in a different format than specified or the passed stream is null, the RichEditControl.InvalidFormatException event fires.

Determine a moment when the document model can be safely modified using the RichEditControl.DocumentLoaded event. Handle the DocumentLayout.DocumentFormatted event to check the loaded document’s layout.