RichEditControl.DocumentLoaded Event

Occurs after a document is loaded into the RichEdit control.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v18.1.dll

Declaration

C#

public event EventHandler DocumentLoaded

VB.NET

Public Event DocumentLoaded As EventHandler

Event Data

The DocumentLoaded event's data class is EventArgs.

Remarks

The DocumentLoaded event fires after executing the RichEditControl.LoadDocument or Document.LoadDocument method and after specifying values for the following properties:

• Document.Text
• Document.RtfText
• Document.OpenXmlBytes
• Document.WordMLText
• Document.HtmlText
• Document.MhtText

The DocumentLoaded fires when the document model is built and the loaded document is valid. Handle the DocumentLayout.DocumentFormatted event to check the loaded document’s layout.

Note

When an HTML document with external image references is loaded, the images are obtained asynchronously and the DocumentLoaded event cannot guarantee image availability at the moment it is raised. The RichEditControl does not provide a technique that allows you to determine the moment when all images are downloaded and inserted in a document.

Tip

A complete sample project is available in the DevExpress Code Examples database at http://www.devexpress.com/example=T258534.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DocumentLoaded event.

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.

VB.NET

how-to-adjust-left-padding-of-a-document-in-richeditcontrol-e3781/VB/Form1.vb#L23

Private Sub richEditControl1_DocumentLoaded(ByVal sender As Object, ByVal e As EventArgs) Handles richEditControl1.DocumentLoaded
    'AdjustParagraphIndent();

export-to-html-how-to-export-only-body-tag-content-and-specify-the-location-of-css-styles-e1726/VB/ExportOnlyBodyContent/Form1.vb#L53

End Sub
Private Sub richEditControl_DocumentLoaded(ByVal sender As Object, ByVal e As EventArgs) Handles richEditControl1.DocumentLoaded
    Try

how-to-use-images-when-implementing-the-mail-merge-functionality-e4164/VB/Form1.vb#L20

Private Sub richEditControl1_DocumentLoaded(ByVal sender As Object, ByVal e As EventArgs) Handles richEditControl1.DocumentLoaded
    richEditControl1.Options.MailMerge.DataSource = NorthwindDataProvider.Categories

how-to-implement-the-document-map-feature-for-richeditcontrols-document-using-a-treelist-c-t164630/VB/WindowsFormsApplication1/Form1.vb#L53

AddHandler richEditControl1.DocumentLoaded, AddressOf richEditControl1_DocumentLoaded
richEditControl1.LoadDocument("BookmarkTemplate.docx")

how-to-create-a-log-viewer-application-e4683/VB/Form1.vb#L26

Private Sub richEditControl1_DocumentLoaded(ByVal sender As Object, ByVal e As EventArgs) Handles richEditControl1.DocumentLoaded
    ApplyDefaultDocumentFormat()

C#

how-to-implement-the-document-map-feature-for-richeditcontrols-document-using-a-treelist-c-t164630/CS/WindowsFormsApplication1/Form1.cs#L48

richEditControl1.DocumentLoaded += new EventHandler(richEditControl1_DocumentLoaded);
richEditControl1.LoadDocument("BookmarkTemplate.docx");

protection-how-to-programmatically-create-a-protected-document-and-apply-range-permissions-e3017/CS/ReadOnlyRangesInCodeExample/Form1.cs#L33

richEditControl1.DocumentLoaded += richEditControl1_DocumentLoaded;

how-to-specify-default-document-formatting-e1398/CS/DefaultDocumentSettingsExample/Form1.cs#L15

    richEditControl1.DocumentClosing += RichEditControl1_DocumentClosing;
    richEditControl1.DocumentLoaded += RichEditControl1_DocumentLoaded;
}

layout-api-how-to-use-layoutiterator-to-traverse-layout-tree-t274525/CS/LayoutIteratorExample/Form1.cs#L24

richEditControl1.LoadDocument("Test.docx");
richEditControl1.DocumentLoaded += richEditControl1_DocumentLoaded;
doc = richEditControl1.Document;

how-to-enable-line-numbering-and-count-the-document-rows-t531470/CS/LineNumberingExample/Form1.cs#L21

richEditControl1.DocumentLoaded += RichEditControl1_DocumentLoaded;
richEditControl1.DocumentLayout.DocumentFormatted += DocumentLayout_DocumentFormatted;