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

Invokes the “Open…” file dialog, creates a specific importer and loads the file.

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()

VB.NET

Public Overridable Function LoadDocument As Boolean

Returns

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

Remarks

File extension determines the document format. The following file extensions are recognized:

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

If the file is in a different format than its extension indicates, or encrypted, it is not loaded. However, you can subscribe to the RichEditControl.InvalidFormatException event which occurs in this situation and examine the RichEditInvalidFormatExceptionEventArgs.Exception property to determine the reason for not loading a document.

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.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the LoadDocument() 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#

winforms-richedit-export-export-only-body-tag-content-and-specify-location-of-css-styles/CS/ExportOnlyBodyContent/Form1.cs#L49

protected internal void OnLoadDocumentClick(object sender, EventArgs e) {
    this.richEditControl1.LoadDocument();
}

VB.NET

winforms-richedit-export-export-only-body-tag-content-and-specify-location-of-css-styles/VB/ExportOnlyBodyContent/Form1.vb#L53

Protected Friend Sub OnLoadDocumentClick(ByVal sender As Object, ByVal e As EventArgs)
    richEditControl1.LoadDocument()
End Sub