RichEditControl.LoadDocument(Stream) 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 the stream.

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
)

VB.NET

Public Overridable Function LoadDocument(
    stream As Stream
) As Boolean

Parameters

Name	Type	Description
stream	Stream	A Stream object that is the stream used to load a document.

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. After loading the document, the stream remains open.

The format of the document loaded from a stream is detected automatically by the built-in IFormatDetectorService service implementation. The following formats are detected:

• DOC, DOCX, RTF, HTM, HTML, MHT, XML, EPUB;
• ODT - non-encrypted files only.

Plain text cannot be detected automatically. To load a plain text document, use another method override with the document format DocumentFormat.PlainText as a parameter.

If the format detection fails 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.

View Example: How to load a document into the RichEditControl

Form1.cs

using (Stream stream = System.Reflection.Assembly.GetExecutingAssembly().GetManifestResourceStream("LoadDocumentExample.TextWithImagesODT"))
{
    richEditControl1.LoadDocument(stream);
}

Form1.vb

Using stream As Stream = System.Reflection.Assembly.GetExecutingAssembly().GetManifestResourceStream("LoadDocumentExample.TextWithImagesODT")
    richEditControl1.LoadDocument(stream)
End Using

Tip

Use LoadDocument method overloads which explicit format definition to improve performance.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the LoadDocument(Stream) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-load-a-document-into-the-richedit-control/CS/LoadDocumentExample/Form1.cs#L39

{
    richEditControl1.LoadDocument(stream);
}

VB.NET

how-to-load-a-document-into-the-richedit-control/VB/LoadDocumentExample/Form1.vb#L35

Using stream As Stream = System.Reflection.Assembly.GetExecutingAssembly().GetManifestResourceStream("TextWithImagesODT")
    richEditControl1.LoadDocument(stream)
End Using