DocumentLayout.GetElement(DocumentPosition, LayoutType) Method

Gets the layout element of the specified type 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 RangedLayoutElement GetElement(
    DocumentPosition position,
    LayoutType type
)

VB.NET

Public Function GetElement(
    position As DocumentPosition,
    type As LayoutType
) As RangedLayoutElement

Parameters

Name	Type	Description
position	DocumentPosition	A DocumentPosition object that specifies the position in the document model.
type	LayoutType	A LayoutType enumeration that specifies the type of the requested layout element.

Returns

Type	Description
RangedLayoutElement	A RangedLayoutElement class descendant if the specified layout type can be related to a document position; otherwise, an exception is thrown.

Remarks

Important

If the specified layout type cannot be related to a document position (e.g. LayoutType.BookmarkStartBox, LayoutType.BookmarkEndBox), an exception is thrown.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetElement(DocumentPosition, LayoutType) 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#L83

DocumentPosition pos = subDoc.CreatePosition(richEditControl1.Document.CaretPosition.ToInt() == 0 ? 0 : richEditControl1.Document.CaretPosition.ToInt() - 1);
LayoutPageArea pageArea = richEditControl1.DocumentLayout.GetElement(pos, LayoutType.PageArea) as LayoutPageArea;
LayoutPage page = pageArea.GetParentByType<LayoutPage>();

layout-api-how-to-use-layoutiterator-to-traverse-layout-tree-t274525/CS/LayoutIteratorExample/Form1.cs#L121

RangedLayoutElement el = richEditControl1.DocumentLayout.GetElement(richEditControl1.Document.CaretPosition, LayoutType.PlainTextBox);
do

VB.NET

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

Dim pos As DocumentPosition = subDoc.CreatePosition(If(richEditControl1.Document.CaretPosition.ToInt() = 0, 0, richEditControl1.Document.CaretPosition.ToInt() - 1))
Dim pageArea As LayoutPageArea = TryCast(richEditControl1.DocumentLayout.GetElement(pos, LayoutType.PageArea), LayoutPageArea)
Dim page As LayoutPage = pageArea.GetParentByType(Of LayoutPage)()

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

Dim el As RangedLayoutElement = richEditControl1.DocumentLayout.GetElement(richEditControl1.Document.CaretPosition, LayoutType.PlainTextBox)
Do