DocumentLayout.DocumentFormatted Event

Fires after the document layout is calculated.

Namespace: DevExpress.XtraRichEdit.API.Layout

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

NuGet Package: DevExpress.RichEdit.Core

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

Declaration

C#

public event EventHandler DocumentFormatted

VB.NET

Public Event DocumentFormatted As EventHandler

Event Data

The DocumentFormatted event's data class is EventArgs.

Remarks

Handle this event to check layout-dependent information, data and objects.

We do not recommend using this event to edit the document. Handle the RichEditControl.ContentChanged (RichEditControl.ContentChanged for WPF) or RichEditControl.DocumentLoaded (RichEditControl.DocumentLoaded for WPF) event instead.

Important

The DocumentFormatted event handler is running in a background (non-UI) thread. Use the RichEditControl.BeginInvoke or Dispatcher.BeginInvoke (WPF) method to avoid concurrency issues. Access the Dispatcher.BeginInvoke method using the RichEditControl.Dispatcher property.

WinForms Example

View Example

Form1.vb

Private Sub DocumentLayout_DocumentFormatted(ByVal sender As Object, ByVal e As EventArgs)

    richEditControl1.BeginInvoke(New Action(Sub()
        Dim pageCount As Integer = richEditControl1.DocumentLayout.GetFormattedPageCount()
        For i As Integer = 0 To pageCount - 1
            Dim visitor As New MyDocumentLayoutVisitor()
            visitor.Visit(richEditControl1.DocumentLayout.GetPage(i))
        Next i
    End Sub))
End Sub

Form1.cs

private void DocumentLayout_DocumentFormatted(object sender, EventArgs e)
{

    richEditControl1.BeginInvoke(new Action(() =>
    {
        int pageCount = richEditControl1.DocumentLayout.GetFormattedPageCount();
        for (int i = 0; i < pageCount; i++)
        {
            MyDocumentLayoutVisitor visitor = new MyDocumentLayoutVisitor();
            visitor.Visit(richEditControl1.DocumentLayout.GetPage(i));
        }
    }));
}

WPF Example

Note

A full code example is available in the WPF Rich Editor Layout API - Simple Example repository on GitHub.

C#

private void DocumentLayout_DocumentFormatted(object sender, EventArgs e)
{

   richEdit.Dispatcher.BeginInvoke(new Action(() =>
   {
     int pageCount = richEdit.DocumentLayout.GetFormattedPageCount();
     for (int i = 0; i < pageCount; i++)
     {
       MyDocumentLayoutVisitor visitor = new MyDocumentLayoutVisitor();
       visitor.Visit(richEdit.DocumentLayout.GetPage(i));
     }
   }));
}

VB.NET

Private Sub DocumentLayout_DocumentFormatted(ByVal sender As Object, ByVal e As EventArgs)

    richEdit.Dispatcher.BeginInvoke(New Action(Sub()
        Dim pageCount As Integer = richEdit.DocumentLayout.GetFormattedPageCount()
        For i As Integer = 0 To pageCount - 1
             Dim visitor As New MyDocumentLayoutVisitor()
             visitor.Visit(richEdit.DocumentLayout.GetPage(i))
             Next i
        End Sub))
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DocumentFormatted 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.

C#

layout-api-simple-example-t245818/CS/LayoutApiSimpleExample/Form1.cs#L17

    richEditControl1.LoadDocument("Grimm.docx");
    richEditControl1.DocumentLayout.DocumentFormatted += DocumentLayout_DocumentFormatted;
}

layout-api-treeview-example-t239200/CS/LayoutApiSample/Form1.cs#L30

richEditControl1.Document.Sections[0].LineNumbering.CountBy = 1;
richEditControl1.DocumentLayout.DocumentFormatted += DocumentLayout_DocumentFormatted;
treeView1.AfterSelect += treeView1_AfterSelect;

how-to-emulate-the-ms-word-information-status-bar-when-using-richeditcontrol-t467150/CS/WindowsFormsApplication1/Form1.cs#L21

    richEditControl1.SelectionChanged += richEditControl1_SelectionChanged;
    richEditControl1.DocumentLayout.DocumentFormatted += DocumentLayout_DocumentFormatted;
}

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

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

VB.NET

layout-api-simple-example-t245818/VB/LayoutApiSimpleExample/Form1.vb#L16

    richEditControl1.LoadDocument("Grimm.docx")
    AddHandler richEditControl1.DocumentLayout.DocumentFormatted, AddressOf DocumentLayout_DocumentFormatted
End Sub

layout-api-treeview-example-t239200/VB/LayoutApiSample/Form1.vb#L29

richEditControl1.Document.Sections(0).LineNumbering.CountBy = 1
AddHandler richEditControl1.DocumentLayout.DocumentFormatted, AddressOf DocumentLayout_DocumentFormatted
AddHandler treeView1.AfterSelect, AddressOf treeView1_AfterSelect

how-to-emulate-the-ms-word-information-status-bar-when-using-richeditcontrol-t467150/VB/WindowsFormsApplication1/Form1.vb#L20

    AddHandler richEditControl1.SelectionChanged, AddressOf richEditControl1_SelectionChanged
    AddHandler richEditControl1.DocumentLayout.DocumentFormatted, AddressOf DocumentLayout_DocumentFormatted
End Sub

how-to-enable-line-numbering-and-count-the-document-rows-t531470/VB/LineNumberingExample/Form1.vb#L24

    AddHandler richEditControl1.DocumentLoaded, AddressOf RichEditControl1_DocumentLoaded
    AddHandler richEditControl1.DocumentLayout.DocumentFormatted, AddressOf DocumentLayout_DocumentFormatted
End Sub