RichEditView.GetVisiblePageLayoutInfos() Method

Obtains information on the layout of visible pages.

Namespace: DevExpress.XtraRichEdit

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

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

Declaration

C#

public List<PageLayoutInfo> GetVisiblePageLayoutInfos()

VB.NET

Public Function GetVisiblePageLayoutInfos As List(Of PageLayoutInfo)

Returns

Type	Description
List<PageLayoutInfo>	A List<T><PageLayoutInfo,> list of layout information on individual pages.

Example

This code snippet illustrates the use of the RichEditView.GetVisiblePageLayoutInfos and RichEditView.GetVisiblePagesRange methods to display information about visible pages and indicate page boundaries.

View Example

Form1.vb

Dim pages As List(Of PageLayoutInfo) = richEditControl1.ActiveView.GetVisiblePageLayoutInfos()
Dim visibleRange As DocumentRange = richEditControl1.ActiveView.GetVisiblePagesRange()

Dim redPen As New Pen(Color.Red, 1)
Dim gr As Graphics = richEditControl1.CreateGraphics()
gr.DrawRectangle(redPen, pages(0).Bounds)

Dim s As String = String.Format("{0} page(s) displayed." & ControlChars.CrLf & "From page {1} which starts at document position {2}." & ControlChars.CrLf & "To page {3} which ends at document position {4}." & ControlChars.CrLf & "First visible page is outlined with red.", pages.Count, pages(0).PageIndex, visibleRange.Start, pages(pages.Count - 1).PageIndex, visibleRange.End)

Form1.cs

List<PageLayoutInfo> pages = richEditControl1.ActiveView.GetVisiblePageLayoutInfos();
DocumentRange visibleRange = richEditControl1.ActiveView.GetVisiblePagesRange();

Pen redPen = new Pen(Color.Red, 1);
Graphics gr = richEditControl1.CreateGraphics();
gr.DrawRectangle(redPen, pages[0].Bounds);

string s = String.Format("{0} page(s) displayed.\r\n" +
    "From page {1} which starts at document position {2}.\r\n" +
    "To page {3} which ends at document position {4}.\r\n" +
    "First visible page is outlined with red.",
pages.Count, pages[0].PageIndex, visibleRange.Start, pages[pages.Count - 1].PageIndex, visibleRange.End);

Related GitHub Examples

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

CustomLayoutVisitor visitor = new CustomLayoutVisitor(richEditControl1.Document);
List<PageLayoutInfo> list = richEditControl1.ActiveView.GetVisiblePageLayoutInfos();

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

#region #GetVisiblePages
List<PageLayoutInfo> pages = richEditControl1.ActiveView.GetVisiblePageLayoutInfos();
DocumentRange visibleRange = richEditControl1.ActiveView.GetVisiblePagesRange();

VB.NET

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

Dim visitor As New CustomLayoutVisitor(richEditControl1.Document)
Dim list As List(Of PageLayoutInfo) = richEditControl1.ActiveView.GetVisiblePageLayoutInfos()
For i As Integer = 0 To list.Count - 1

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

'            #Region "#GetVisiblePages"
            Dim pages As List(Of PageLayoutInfo) = richEditControl1.ActiveView.GetVisiblePageLayoutInfos()
            Dim visibleRange As DocumentRange = richEditControl1.ActiveView.GetVisiblePagesRange()