DocumentLayout.GetElement<T>(DocumentPosition) Method

Returns the layout element of the type designated by the specified generic type parameter which relates to the specified position in the document model.

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 T GetElement<T>(
    DocumentPosition position
)
    where T : RangedLayoutElement

VB.NET

Public Function GetElement(Of T As RangedLayoutElement)(
    position As DocumentPosition
) As T

Parameters

Name	Type	Description
position	DocumentPosition	A DocumentPosition object that specifies the position in the document model.

Type Parameters

Name	Description
T

Returns

Type	Description
T	The layout element of the type designated by the specified generic type parameter.

Remarks

The DocumentLayout object returns information about visible elements only. If the passed DocumentPosition is hidden, the GetElement method returns null.

Example

This code snippet checks whether the first table in the document is located on the second page.

View Example

Form1.cs

DevExpress.XtraRichEdit.API.Native.Table table = richEditControl1.Document.Tables.First;
if (table != null)
{
    // Obtain the layout element related to the table.
    LayoutTable ltable = richEditControl1.DocumentLayout.GetElement<LayoutTable>(table.Range.Start);
    // Obtain zero-based page index of the page containing the layout element.
    int pageIndex = this.richEditControl1.DocumentLayout.GetPageIndex(ltable);
    // Check whether the layout element is located at the second page.
    string s = "Layout verified.";
    if (pageIndex != 1)
        s = "The first table is not on the page 2. Review pagination.";
    MessageBox.Show(s, "Check Layout", MessageBoxButtons.OK, MessageBoxIcon.Information);
}

Form1.vb

Dim table As DevExpress.XtraRichEdit.API.Native.Table = richEditControl1.Document.Tables.First
If table IsNot Nothing Then
    ' Obtain the layout element related to the table.
    Dim ltable As LayoutTable = richEditControl1.DocumentLayout.GetElement(Of LayoutTable)(table.Range.Start)
    ' Obtain zero-based page index of the page containing the layout element.
    Dim pageIndex As Integer = Me.richEditControl1.DocumentLayout.GetPageIndex(ltable)
    ' Check whether the layout element is located at the second page.
    Dim s As String = "Layout verified."
    If pageIndex <> 1 Then
        s = "The first table is not on the page 2. Review pagination."
    End If
    MessageBox.Show(s, "Check Layout", MessageBoxButtons.OK, MessageBoxIcon.Information)
End If

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetElement<T>(DocumentPosition) method.

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#L66

// Obtain the layout element related to the table.
LayoutTable ltable = richEditControl1.DocumentLayout.GetElement<LayoutTable>(table.Range.Start);
// Obtain zero-based page index of the page containing the layout element.

document-layout-api-practical-usage-t266080/CS/WindowsFormsApplication1/DocumentLayoutHelper/RichEditDocumentLayoutAnalyzer.cs#L24

// collect information about CURRENT PAGE
RangedLayoutElement layoutPosition = currentDocumentLayout.GetElement<RangedLayoutElement>(docPosition);
if(layoutPosition != null) {

VB.NET

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

' Obtain the layout element related to the table.
Dim ltable As LayoutTable = richEditControl1.DocumentLayout.GetElement(Of LayoutTable)(table.Range.Start)
' Obtain zero-based page index of the page containing the layout element.

document-layout-api-practical-usage-t266080/VB/WindowsFormsApplication1/DocumentLayoutHelper/RichEditDocumentLayoutAnalyzer.vb#L29

' collect information about CURRENT PAGE
Dim layoutPosition As RangedLayoutElement = currentDocumentLayout.GetElement(Of RangedLayoutElement)(docPosition)
If layoutPosition IsNot Nothing Then