RichEditControl.DocumentLoaded Event

Occurs after the document is fully loaded.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v19.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 occurs when the document model is built and the loaded document is valid.

Call the RichEditControl.LoadDocument or Document.LoadDocument method to load a document.

You can specify the following properties to load content in the specific format:

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

Handle the DocumentLayout.DocumentFormatted event to check the loaded document’s layout.

Note

The RichEditControl does not provide a technique to determine the moment when all images with external references are downloaded and inserted in an HTML document.

The code sample below shows how to update fields in the main body of a loaded document:

C#

richEditControl.DocumentLoaded += RichEditControl_DocumentLoaded;
richEditControl.LoadDocument("FirstLook.docx");


private void RichEditControl_DocumentLoaded(object sender, EventArgs e)
{
    RichEditControl control = sender as RichEditControl;
    if (control.Document.Fields.Count != 0)
    {
        control.Document.Fields.Update();
    }
}

VB.NET

AddHandler richEditControl.DocumentLoaded, AddressOf RichEditControl_DocumentLoaded
richEditControl.LoadDocument("FirstLook.docx")


private void RichEditControl_DocumentLoaded(Object sender, EventArgs e)
    Dim control As RichEditControl = TryCast(sender, RichEditControl)
    If control.Document.Fields.Count <> 0 Then
        control.Document.Fields.Update()
    End If

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

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

table-api-creating-table-a-simple-example-e3242/VB/Walkthrough_Creating_Table/Form1.vb#L20

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

how-to-specify-default-document-formatting-e1398/VB/DefaultDocumentSettingsExample/Form1.vb#L16

    AddHandler richEditControl1.DocumentClosing, AddressOf RichEditControl1_DocumentClosing
    AddHandler richEditControl1.DocumentLoaded, AddressOf RichEditControl1_DocumentLoaded
End Sub

layout-api-how-to-use-layoutiterator-to-traverse-layout-tree-t274525/VB/LayoutIteratorExample/Form1.vb#L23

richEditControl1.LoadDocument("Test.docx")
AddHandler richEditControl1.DocumentLoaded, AddressOf richEditControl1_DocumentLoaded
doc = richEditControl1.Document

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-retain-original-image-uri-in-html-document-e3189/CS/HTML_Export_ImageSourceExample/Form1.cs#L15

InitializeComponent();
richEditControl1.DocumentLoaded += richEditControl1_DocumentLoaded;
richEditControl1.CreateNewDocument();