The requested page is not available for the requested platform. You are viewing the content for .NET Framework 4.5.2+ platform.
.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
Box

DevExpress.XtraRichEdit.API.Layout Namespace

Contains base interfaces and classes which constitute the Layout API of the Rich Edit Suite.

Classes

Name Description
BookmarkBox

Layout element that relates to the Bookmark start and end visual indicators.

BookmarkBoxCollection

A collection of BookmarkBox elements.

Box

Base class for inline layout elements.

BoxCollection

A collection of Box elements.

CharacterBox

Layout element which relates to a single character in the PlainTextBox element.

CharacterBoxCollection

A collection of CharacterBox layout elements.

CommentBox

Layout element that relates to the Comment start and end visual indicators.

CommentBoxCollection

A collection of CommentBox elements.

CommentHighlightAreaBox

Layout element that relates to the highlighted range to which a comment is assigned.

CommentHighlightAreaCollection

A collection of CommentHighlightAreaBox elements.

DocumentLayout

Provides access to the Layout API.

DocumentLayoutInvalidatedEventArgs

Provides data for the DocumentLayout.DocumentLayoutInvalidated event.

FieldHighlightAreaBox

Layout element that relates to the highlighted text of the document Field.

FieldHighlightAreaCollection

A collection of FieldHighlightAreaBox elements.

FloatingObjectAnchorBox

Layout element that relates to the anchoring the Shape.Range of the floating object.

HiddenTextUnderlineBox

Layout element that relates to the visualization of the hidden text in the document.

HiddenTextUnderlineBoxCollection

A collection of HiddenTextUnderlineBox elements.

HighlightAreaBox

Layout element that relates to the highlighted text.

HighlightAreaCollection

A collection of HighlightAreaBox elements.

InlineDrawingObjectBox

Layout element that relates to the drawing objects.

InlinePictureBox

Layout element that relates to the inline pictures.

LayoutColumn

Layout element that relates to the column in the section.

LayoutColumnCollection

A collection of LayoutColumn objects.

LayoutComment

Layout element that relates to the Comment in the document.

LayoutCommentCollection

A collection of LayoutComment elements.

LayoutElementBase

Base class for layout elements.

LayoutElementCollection<T>

Base collection for collections of layout elements.

LayoutFloatingObject

Base class for layout element that relates to the floating object.

LayoutFloatingObjectCollection

A collection of LayoutFloatingObject elements.

LayoutFloatingPicture

Layout element that relates to the floating picture in the document.

LayoutFooter

Layout element that relates to the document's footer.

LayoutFrame

Represents a frame object in the document.

LayoutFrameCollection

A collection of LayoutFrame objects.

LayoutHeader

Layout element that relates to the document's header.

LayoutIterator

Navigates the layout tree and provides access to individual elements.

LayoutPage

A page of the document layout.

LayoutPageArea

Layout element that relates to a page body - a page without headers, footers, comments and floating objects.

LayoutPageAreaBase

Base element for parts of a page which relate to document ranges.

LayoutPageAreaCollection

A collection of LayoutPageArea elements.

LayoutPageCollection

A collection of LayoutPage elements.

LayoutRow

A line on a page.

LayoutRowCollection

A collection of LayoutRow elements.

LayoutTable

Layout element that relates to a Table object.

LayoutTableCell

Layout element that relates to a TableCell object.

LayoutTableCellCollection

A collection of LayoutTableCell elements.

LayoutTableCollection

A collection of LayoutTable elements.

LayoutTableRow

Layout element that relates to a TableRow object.

LayoutTableRowCollection

A collection of LayoutTableRow elements.

LayoutTextBox

Layout element that relates to a floating object - Text Box.

LayoutVisitor

Defines the basic functionality that should be implemented by visitors that traverse the document layout tree.

LineNumberBox

Layout element that relates to a line number.

LineNumberBoxCollection

A collection of LineNumberBox elements.

NumberingListMarkBox

Base class for a mark in the numbered list.

NumberingListWithSeparatorBox

Layout element that relates to a mark in the numbered list.

PageCanvas

Encapsulates the layout drawing surface.

PageFormattedEventArgs

Provides data for the DocumentLayout.PageFormatted event.

PagePainter

Base class to implement custom drawing for layout elements.

ParagraphFrameBox

Layout element that relates to a text paragraph frame.

ParagraphFrameBoxCollection

A collection of ParagraphFrameBox objects.

PlainTextBox

Layout elements related to text runs in a line.

RangePermissionBox

Layout element that relates to the Range Permission start and end visual indicators.

RangePermissionBoxCollection

A collection of RangePermissionBox elements.

RangePermissionHighlightAreaBox

Layout element that relates to the highlighted range which visualizes the RangePermission.Range value.

RangePermissionHighlightAreaCollection

A collection of RangePermissionHighlightAreaBox elements.

RangedLayoutElementBase

Base class for layout elements related to document objects based on the FixedRange.

RowExtendedBoxes

Container for collections of objects of the PlainTextBox type and various LayoutType characteristics. LayoutType.PlainTextBox elements are not included.

StrikeoutBox

Layout element that relates to the striked text.

StrikeoutBoxCollection

A collection of StrikeoutBox elements.

UnderlineBox

Layout element that relates to the underlined text.

UnderlineBoxCollection

A collection of UnderlineBox elements.

Interfaces

Name Description
LayoutElement

Base interface for layout elements.

RangedLayoutElement

Defines a layout element which has a related DocumentRange.

Structs

Name Description
Borders

A structure that combines characteristics of borders for the layout table or cell.

LayoutBorder

Combines border characteristics.

Delegates

Name Description
DocumentLayoutInvalidatedEventHandler

A method that will handle the DocumentLayout.DocumentLayoutInvalidated event.

PageFormattedEventHandler

A method that will handle the DocumentLayout.PageFormatted event.

Enums

Name Description
CanvasOwnerType

Lists the output devices to which the document layout is rendered.

InitialState

Used by the LayoutIterator.Reset method to specify the initial position of the iterator.

LayoutLevel

Lists levels in the document layout tree at which the LayoutIterator navigates.

LayoutType

Lists types of layout elements in a document.