Back to Devexpress

RichEditControl.DocumentLayout Property

windowsforms-devexpress-dot-xtrarichedit-dot-richeditcontrol-e8a131dd.md

latest3.4 KB
Original Source

RichEditControl.DocumentLayout Property

Provides access to Layout API.

Namespace : DevExpress.XtraRichEdit

Assembly : DevExpress.XtraRichEdit.v25.2.dll

NuGet Package : DevExpress.Win.RichEdit

Declaration

csharp
[Browsable(false)]
public DocumentLayout DocumentLayout { get; }
vb
<Browsable(False)>
Public ReadOnly Property DocumentLayout As DocumentLayout

Property Value

TypeDescription
DocumentLayout

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

|

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.

winforms-richedit-layout-api-practical-usage/CS/WindowsFormsApplication1/Form1.cs#L25

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

winforms-richedit-layout-api-practical-usage/VB/WindowsFormsApplication1/Form1.vb#L27

vb
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

richedit-winforms-layout-element-under-cursor/VB/ToolTip/Form1.vb#L28

vb
'Create a HitTestManager instance:
Dim hitTest As HitTestManager = New HitTestManager(richEditControl1.DocumentLayout)
'Perform the hit test and pass the result to the RichEditHitTestResult object:

See Also

Layout API

RichEditControl Class

RichEditControl Members

DevExpress.XtraRichEdit Namespace