Back to Devexpress

DevExpress.XtraRichEdit.API.Layout Namespace

officefileapi-devexpress-dot-xtrarichedit-dot-api.md

latest18.3 KB
Original Source

DevExpress.XtraRichEdit.API.Layout Namespace

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

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

NuGet Package : DevExpress.RichEdit.Core

Classes

NameDescription
BookmarkBoxLayout element that relates to the Bookmark start and end visual indicators.
BookmarkBoxCollectionA collection of BookmarkBox elements.
BoxBase class for inline layout elements.
BoxCollectionA collection of Box elements.
ChangedLineMarkBoxLayout element that relates to the markup indicating changes lines when the Track Changes feature is enabled.
CharacterBoxLayout element which relates to a single character in the PlainTextBox element.
CharacterBoxCollectionA collection of CharacterBox layout elements.
CheckBoxA layout element which relates to the check box.
CommentBoxLayout element that relates to the Comment start and end visual indicators.
CommentBoxCollectionA collection of CommentBox elements.
CommentHighlightAreaBoxLayout element that relates to the highlighted range to which a comment is assigned.
CommentHighlightAreaCollectionA collection of CommentHighlightAreaBox elements.
DeletedTextMarkBoxThe type of layout element of the DeletedTextMarkBox class.
DocumentLayoutProvides access to the Layout API.
DocumentLayoutInvalidatedEventArgsProvides data for the DocumentLayout.DocumentLayoutInvalidated event.
FieldHighlightAreaBoxLayout element that relates to the highlighted text of the document Field.
FieldHighlightAreaCollectionA collection of FieldHighlightAreaBox elements.
FloatingObjectAnchorBoxLayout element that relates to the anchoring the Shape.Range of the floating object.
HiddenTextUnderlineBoxLayout element that relates to the visualization of the hidden text in the document.
HiddenTextUnderlineBoxCollectionA collection of HiddenTextUnderlineBox elements.
HighlightAreaBoxLayout element that relates to the highlighted text.
HighlightAreaCollectionA collection of HighlightAreaBox elements.
InlineDrawingObjectBoxLayout element that relates to the drawing objects.
InlinePictureBoxLayout element that relates to the inline pictures.
LayoutColumnLayout element that relates to the column in the section.
LayoutColumnCollectionA collection of LayoutColumn objects.
LayoutCommentLayout element that relates to the Comment in the document.
LayoutCommentCollectionA collection of LayoutComment elements.
LayoutElementBaseBase class for layout elements.
LayoutElementCollection<T>Base collection for collections of layout elements.
LayoutFloatingObjectBase class for layout element that relates to the floating object.
LayoutFloatingObjectCollectionA collection of LayoutFloatingObject elements.
LayoutFloatingPictureLayout element that relates to the floating picture in the document.
LayoutFloatingTableLayout element that relates to the floating table in the document.
LayoutFooterLayout element that relates to the document’s footer.
LayoutFootnoteLayout element that relates to the footnote.
LayoutFrameRepresents a frame object in the document.
LayoutFrameCollectionA collection of LayoutFrame objects.
LayoutHeaderLayout element that relates to the document’s header.
LayoutIteratorNavigates the layout tree and provides access to individual elements.
LayoutNoteCollectionA collection of LayoutNote elements.
LayoutPageA page of the document layout.
LayoutPageAreaLayout element that relates to a page body - a page without headers, footers, comments and floating objects.
LayoutPageAreaBaseBase element for parts of a page which relate to document ranges.
LayoutPageAreaCollectionA collection of LayoutPageArea elements.
LayoutPageBordersLayout element that relates to the page borders.
LayoutPageCollectionA collection of LayoutPage elements.
LayoutRowA line on a page.
LayoutRowCollectionA collection of LayoutRow elements.
LayoutTableLayout element that relates to a Table object.
LayoutTableCellLayout element that relates to a TableCell object.
LayoutTableCellCollectionA collection of LayoutTableCell elements.
LayoutTableCollectionA collection of LayoutTable elements.
LayoutTableHeaderLayout element that relates to a table header.
LayoutTableRowLayout element that relates to a TableRow object.
LayoutTableRowCollectionA collection of LayoutTableRow elements.
LayoutTextBoxLayout element that relates to a floating object - Text Box.
LayoutVisitorDefines the basic functionality that should be implemented by visitors that traverse the document layout tree.
LineNumberBoxLayout element that relates to a line number.
LineNumberBoxCollectionA collection of LineNumberBox elements.
NoteContinuationSeparatorBoxLayout element that relates to a footnote and endnote continuation separator (a separator for the note that continues on the next page).
NoteSeparatorBoxLayout element that relates to a footnote and endnote separator (a line which separates footnotes and endnotes from the body text).
NumberingListMarkBoxBase class for a mark in the numbered list.
NumberingListWithSeparatorBoxLayout element that relates to a mark in the numbered list.
PageCanvasEncapsulates the layout drawing surface.
PageFormattedEventArgsProvides data for the DocumentLayout.PageFormatted event.
PagePainterBase class to implement custom drawing for layout elements.
ParagraphFrameBoxLayout element that relates to a text paragraph frame.
ParagraphFrameBoxCollectionA collection of ParagraphFrameBox objects.
PlainTextBoxLayout elements related to text runs in a line.
RangedLayoutElementBaseBase class for layout elements related to document objects based on the FixedRange.
RangePermissionBoxLayout element that relates to the Range Permission start and end visual indicators.
RangePermissionBoxCollectionA collection of RangePermissionBox elements.
RangePermissionHighlightAreaBoxLayout element that relates to the highlighted range which visualizes the RangePermission.Range value.
RangePermissionHighlightAreaCollectionA collection of RangePermissionHighlightAreaBox elements.
RowExtendedBoxesContainer for collections of objects of the PlainTextBox type and various LayoutType characteristics. LayoutType.PlainTextBox elements are not included.
StrikeoutBoxLayout element that relates to the strikeout text.
StrikeoutBoxCollectionA collection of StrikeoutBox elements.
UnderlineBoxLayout element that relates to the underlined text.
UnderlineBoxCollectionA collection of UnderlineBox elements.
ZeroWidthSpaceBoxLayout element that relates to the zero-width space (used in languages without visible space between words).

Interfaces

NameDescription
LayoutElementBase interface for layout elements.
RangedLayoutElementDefines a layout element which has a related DocumentRange.

Structs

NameDescription
BordersA structure that combines characteristics of borders for the layout page, table or cell.
LayoutBorderCombines border characteristics.

Delegates

NameDescription
DocumentLayoutInvalidatedEventHandlerA method that will handle the DocumentLayout.DocumentLayoutInvalidated event.
PageFormattedEventHandlerA method that will handle the DocumentLayout.PageFormatted event.

Enums

NameDescription
CanvasOwnerTypeLists the output devices to which the document layout is rendered.
InitialStateUsed by the LayoutIterator.Reset method to specify the initial position of the iterator.
LayoutLevelLists levels in the document layout tree at which the LayoutIterator navigates.
LayoutTypeLists types of layout elements in a document.