[Expand]General Information
[Expand]WinForms Controls
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Collapse]WPF Controls
  Prerequisites
 [Expand]What's Installed
 [Expand]Common Concepts
 [Expand]MVVM Framework
 [Collapse]Controls and Libraries
   Reporting
  [Expand]Data Grid
  [Expand]Ribbon, Bars and Menu
  [Expand]Charts Suite
  [Expand]Pivot Grid
  [Expand]Scheduler
  [Expand]Spreadsheet
  [Collapse]Rich Text Editor
   [Expand]Product Information
    Product Class Structure
    Supported Formats
   [Expand]Getting Started
   [Expand]RichEditControl Document
   [Expand]Fields
    Text Formatting
    Import and Export
   [Collapse]Page Layout
     Line Numbering
     Table of Contents
     Layout API
     Measure Units
    Printing
    AutoCorrect
    Mail Merge
    Restrictions and Protection
    Syntax Highlighting
    Traversing the Document
   [Expand]Visual Elements
    Services
    Events
    Commands
    HTML Tag Support
   [Expand]Examples
  [Expand]Tree List
  [Expand]Gauge Controls
  [Expand]Map Control
  [Expand]Layout Management
  [Expand]Windows Modern UI
  [Expand]Printing-Exporting
  [Expand]Data Editors
  [Expand]Navigation Controls
  [Expand]Spell Checker
  [Expand]Property Grid
  [Expand]PDF Viewer
  [Expand]TreeMap Control
  [Expand]Diagram Control
  [Expand]Windows and Utility Controls
   Dialogs, Notifications and Panels
  [Expand]Scheduler (legacy)
 [Expand]Scaffolding Wizard
 [Expand]Localization
  Redistribution and Deployment
  Get More Help
 [Expand]API Reference
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Office File API
[Expand]Reporting
[Expand]Report and Dashboard Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation

Layout API

This document introduces Layout API for the Rich Text Editor - objects, properties and methods that allow you traverse the document layout tree and access layout elements.

Expanded Layout API Overview

The Layout API is located in the DevExpress.RichEdit.v18.1.Core.dll assembly, and is available for both WinForms and WPF Rich Text Editor, as well as for Word Processing Document API. It can be used to arbitrarily display layout elements and draw graphics within the element boundaries (expected in future versions) .

Expanded Layout API Object Model

The document layout model in the Layout API is a hierarchical tree-like structure. Each node in a tree is an instance of a certain class which implements a base interface named LayoutElement. A class representing a particular element is named after that element with addition of the prefix Layout or a suffix Box. There are LayoutPage, LayoutHeader, LayoutPageArea, LayoutFooter, ... BookmarkBox, PlainTextBox etc. A layout element may or may not have a related RangedLayoutElement.Range in the document.

The structure of a sample document is shown in the picture below. The document consists of three pages, has a header and a footer, the first page has a floating text box and a floating picture. The text is organized in one column, the first page has only three lines of text. The first line of text includes a floating object's anchor and five plain text boxes (a plain text box can be a space, a text with uniform formatting or a paragraph mark).

Tip

Call the HitTestManager.HitTest method to obtain the RichEditHitTestResult instance containing information about the element located under the test point. Refer to the How to: Determine the Document Element under the Mouse Pointer topic for details.

Expanded Starting Point

The main entry point of the Layout API in WPF Rich Editor is the RichEditControl.DocumentLayout property. This property provides access to the DocumentLayout object containing basic properties and methods for working with the hierarchy of the document layout objects. After any changes in text or formatting, the document layout is recalculated and the DocumentLayout.DocumentFormatted event fires.

Note

The DocumentFormatted event handler is running in a background thread. To avoid concurrency issues, execute the code which affects the document or interacts with the user asynchronously in a UI thread using the RichEditControl.BeginInvoke method.

Expanded Traversing Layout Tree

To get access to elements which constitute the document's layout, create a Visitor object (that is, the object that implements a Visitor pattern) and visit a node of the document layout tree. Subsequently your visitor will traverse down the tree and visit every child node. For each node, it may call a specific method. At this time, you can only get information on the visited node. However, future API versions will allow you to hide the element, change the order in which elements are rendered or draw custom graphics.

The Visitor object must be a descendant of the LayoutVisitor abstract class. For each layout element, the LayoutVisitor class has a virtual method, thus the descending class must override this method to get access to an element of a particular type. The following code is a visitor class which gets access to every line of text in the main body of the document. Then, it prints visual coordinates and the document position at which the line starts. A line in the document is a LayoutRow object in terms of Layout API. The VisitRow method will be automatically called for each line.

A simple Visitor named MyDocumentLayoutVisitor is implemented in the following code:

Show Me

A complete sample project is available in the DevExpress Code Examples database at http://www.devexpress.com/example=T250783.

To start traversing the tree, pass the node (in this situation, it is the document's page, the LayoutPage object) of the document's layout tree to the Visit method of the MyDocumentLayoutVisitor class. Handle the DocumentLayout.DocumentFormatted event and use the code below:

Show Me

A complete sample project is available in the DevExpress Code Examples database at http://www.devexpress.com/example=T250783.

When the code is executed, the visitor traverses the tree and prints the coordinates of each row and related range.

Expanded Navigation with LayoutIterator

To step through elements of the document layout, use the LayoutIterator object. It navigates the layout tree and provides access to individual elements.

To start navigation, create an iterator using the LayoutIterator.LayoutIterator constructor and call LayoutIterator.MoveNext or LayoutIterator.MovePrevious method. The LayoutIterator.Current property obtains the current layout element.

Expanded Custom Draw

The RichEditControl.BeforePagePaint event allows you to specify a descendant of the PagePainter class to implement custom draw for layout elements.

The following code snippet illustrates how to custom draw the PlainTextBox and LayoutFloatingPicture elements.

Show Me

A complete sample project is available in the DevExpress Code Examples database at http://www.devexpress.com/example=T250783.

This code snippet illustrates the implementation of a PagePainter descendant. It draws color rectangles in place of the words and labels a floating picture with a text string drawn over it.

Is this topic helpful?​​​​​​​