DocumentLayout.GetPageIndex(LayoutElement) Method

Obtains the index of the page containing the specified layout element.

Namespace: DevExpress.XtraRichEdit.API.Layout

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

NuGet Package: DevExpress.RichEdit.Core

Declaration

C#

public int GetPageIndex(
    LayoutElement element
)

VB.NET

Public Function GetPageIndex(
    element As LayoutElement
) As Integer

Parameters

Name	Type	Description
element	LayoutElement	A LayoutElement descendant that is the layout element being queried for the parent page.

Returns

Type	Description
Int32	An integer that is the page index.

Related GitHub Examples

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

winforms-richedit-layout-api-practical-usage/CS/WindowsFormsApplication1/DocumentLayoutHelper/PageLayoutHelper.cs#L14

int currentPageIndex = currentDocumentLayout.GetPageIndex(currentPage);
int totalPageCount = currentDocumentLayout.GetFormattedPageCount();

winforms-richedit-layout-api/CS/LayoutApiSimpleExample/Form1.cs#L68

// 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.

VB.NET

winforms-richedit-layout-api-practical-usage/VB/WindowsFormsApplication1/DocumentLayoutHelper/PageLayoutHelper.vb#L17

Dim currentPageIndex As Integer = currentDocumentLayout.GetPageIndex(currentPage)
Dim totalPageCount As Integer = currentDocumentLayout.GetFormattedPageCount()

winforms-richedit-layout-api/VB/LayoutApiSimpleExample/Form1.vb#L55

' 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.