RichEditControl.DocumentLoaded Event

Occurs after a document is loaded into the RichEdit control.

Namespace: DevExpress.Xpf.RichEdit

Assembly: DevExpress.Xpf.RichEdit.v20.2.dll

NuGet Packages: DevExpress.WindowsDesktop.Wpf.RichEdit, DevExpress.Wpf.RichEdit

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.

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

C#

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

private void RichEditControl1_DocumentLoaded(object sender, EventArgs e)
{
    richEditControl1.BeginInvoke(new Action(() =>
    {
        if (richEditControl1.Document.Fields.Count != 0)
        {
            richEditControl1.Document.Fields.Update();
        }
    }));
}

VB.NET

Private Sub RichEditControl1_DocumentLoaded(ByVal sender As Object, ByVal e As EventArgs)
  richEditControl1.BeginInvoke(New Action(Sub()
    If richEditControl1.Document.Fields.Count <> 0 Then
      richEditControl1.Document.Fields.Update()
    End If
  End Sub))
End Sub

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.

XAML

dxrichedit-for-wpf-table-api-creating-table-a-simple-example-e3266/CS/MainWindow.xaml#L18

    </StackPanel>
    <dxre:RichEditControl Name="richEditControl1" Grid.Row="1" DocumentLoaded ="richEditControl1_DocumentLoaded" EmptyDocumentCreated ="richEditControl1_EmptyDocumentCreated"/>
</Grid>

how-to-export-to-html-only-body-tag-content-and-specify-css-location-e3270/CS/MainWindow.xaml#L28

<dx:GroupFrame Header="RichEditControl">
    <dxre:RichEditControl Name="richEditControl1" DocumentLoaded="richEditControl1_DocumentLoaded" EmptyDocumentCreated="richEditControl1_EmptyDocumentCreated" />
</dx:GroupFrame>

dxrichedit-for-wpf-how-to-retain-original-image-uri-in-html-document/CS/HTML_Export_ImageSourceExample/MainWindow.xaml#L21

<TextBlock x:Name="textBlock" Grid.Column="1" TextWrapping="Wrap" VerticalAlignment="Center" Background="AntiqueWhite" />
<dxre:RichEditControl Name="richEditControl1" Loaded="richEditControl1_Loaded" DocumentLoaded="richEditControl1_DocumentLoaded" Grid.Row="1" />
<TextBox Name="memoEdit1" Grid.Column="1" TextWrapping="Wrap" Grid.Row="1" ScrollViewer.VerticalScrollBarVisibility="Auto"  />