RichEditControl.DocumentLayout Property

Provides access to Layout API.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v20.1.dll

NuGet Package: DevExpress.Win.RichEdit

Declaration

C#

[Browsable(false)]
public DocumentLayout DocumentLayout { get; }

VB.NET

<Browsable(False)>
Public ReadOnly Property DocumentLayout As DocumentLayout

Property Value

Type	Description
DocumentLayout	A DocumentLayout object that is the key object for Layout API.

Related GitHub Examples

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

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-how-to-use-layoutiterator-to-traverse-layout-tree-t274525/CS/LayoutIteratorExample/Form1.cs#L30

{
    layoutIterator = new LayoutIterator(richEditControl1.DocumentLayout);
}

document-layout-api-practical-usage-t266080/CS/WindowsFormsApplication1/Form1.cs#L25

private void barButtonItem1_ItemClick(object sender, DevExpress.XtraBars.ItemClickEventArgs e) {
    memoEdit1.Text = RichEditDocumentLayoutAnalyzer.GetInformationAboutRichEditDocumentLayout(richEditControl1.Document, richEditControl1.DocumentLayout);
}

how-to-insert-a-checkbox-into-a-richeditcontrol-document-t600135/CS/RichEditControl_CheckBox/Form1.cs#L41

LayoutPage layoutPage = richEditControl1.DocumentLayout.GetPage(pageIndex);
HitTestManager hitTest = new HitTestManager(richEditControl1.DocumentLayout);
RichEditHitTestResult result = hitTest.HitTest(layoutPage, point);

VB.NET

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

Private Sub richEditControl1_DocumentLoaded(ByVal sender As Object, ByVal e As EventArgs)
    layoutIterator = New LayoutIterator(richEditControl1.DocumentLayout)
End Sub

document-layout-api-practical-usage-t266080/VB/WindowsFormsApplication1/Form1.vb#L27

Private Sub barButtonItem1_ItemClick(ByVal sender As Object, ByVal e As DevExpress.XtraBars.ItemClickEventArgs) Handles barButtonItem1.ItemClick
    memoEdit1.Text = RichEditDocumentLayoutAnalyzer.GetInformationAboutRichEditDocumentLayout(richEditControl1.Document, richEditControl1.DocumentLayout)
End Sub

how-to-insert-a-checkbox-into-a-richeditcontrol-document-t600135/VB/RichEditControl_CheckBox/Form1.vb#L39

Dim layoutPage As LayoutPage = richEditControl1.DocumentLayout.GetPage(pageIndex)
Dim hitTest As New HitTestManager(richEditControl1.DocumentLayout)
Dim result As RichEditHitTestResult = hitTest.HitTest(layoutPage, point)