DocumentLayout.GetPage(Int32) Method

Gets the page of the document layout by the specified index.

Namespace: DevExpress.XtraRichEdit.API.Layout

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

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Declaration

C#

public LayoutPage GetPage(
    int pageIndex
)

VB.NET

Public Function GetPage(
    pageIndex As Integer
) As LayoutPage

Parameters

Name	Type	Description
pageIndex	Int32	An integer that is the index of a requested page.

Returns

Type	Description
LayoutPage	A LayoutPage object that is the page of the document layout.

Remarks

If the document layout is ready and up-to-date, the GetPage method returns the page with the specified index. Otherwise, the document layout is calculated from the beginning, creating pages until a page with the specified index is ready. The DocumentLayout.PageFormatted and DocumentLayout.DocumentFormatted events may occur in this situation.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetPage(Int32) 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-emulate-the-ms-word-status-bar/CS/WindowsFormsApplication1/Form1.cs#L41

    visitor.Reset();
    visitor.Visit(richEditControl1.DocumentLayout.GetPage(list[i].PageIndex));
}

winforms-richedit-layout-api-practical-usage/CS/WindowsFormsApplication1/DocumentLayoutHelper/RichEditDocumentLayoutAnalyzer.cs#L27

    int currentPageIndex = currentDocumentLayout.GetPageIndex(layoutPosition);
    returnedInformation += PageLayoutHelper.GetInformationAboutCurrentPage(currentDocumentLayout, currentDocumentLayout.GetPage(currentPageIndex), docPosition);
}

winforms-richedit-enable-line-numbering-and-count-document-rows/CS/LineNumberingExample/Form1.cs#L79

for (int i = 0; i < pageCount; i++) {
    visitor.Visit(richEditControl1.DocumentLayout.GetPage(i));
}

word-document-api-examples/CS/CodeExamples/BasicActions.cs#L53

// Access the document page.
DevExpress.XtraRichEdit.API.Layout.LayoutPage layoutPage = wordProcessor.DocumentLayout.GetPage(i);

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

    MyDocumentLayoutVisitor visitor = new MyDocumentLayoutVisitor();
    visitor.Visit(richEditControl1.DocumentLayout.GetPage(i));
}

VB.NET

winforms-richedit-emulate-the-ms-word-status-bar/VB/WindowsFormsApplication1/Form1.vb#L34

    visitor.Reset()
    visitor.Visit(richEditControl1.DocumentLayout.GetPage(list(i).PageIndex))
Next i

winforms-richedit-layout-api-practical-usage/VB/WindowsFormsApplication1/DocumentLayoutHelper/RichEditDocumentLayoutAnalyzer.vb#L32

    Dim currentPageIndex As Integer = currentDocumentLayout.GetPageIndex(layoutPosition)
    returnedInformation &= PageLayoutHelper.GetInformationAboutCurrentPage(currentDocumentLayout, currentDocumentLayout.GetPage(currentPageIndex), docPosition)
End If

winforms-richedit-enable-line-numbering-and-count-document-rows/VB/LineNumberingExample/Form1.vb#L74

For i As Integer = 0 To pageCount - 1
    visitor.Visit(richEditControl1.DocumentLayout.GetPage(i))
Next

word-document-api-examples/VB/CodeExamples/BasicActions.vb#L53

' Access the document page.
Dim layoutPage As DevExpress.XtraRichEdit.API.Layout.LayoutPage = wordProcessor.DocumentLayout.GetPage(i)
' Access the range of the page's main area.

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

    Dim visitor As New MyDocumentLayoutVisitor()
    visitor.Visit(richEditControl1.DocumentLayout.GetPage(i))
Next i