PlainTextBox Class

Layout elements related to text runs in a line.

Namespace: DevExpress.XtraRichEdit.API.Layout

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

Declaration

C#

public class PlainTextBox :
    Box

VB.NET

Public Class PlainTextBox
    Inherits Box

Related API Members

The following members accept/return PlainTextBox objects:

• NumberingListWithSeparatorBox.Separator

Remarks

Use DocumentLayout.GetElement, DocumentLayout.GetElement<T> methods or the LayoutVisitor and LayoutIterator objects to access the PlainTextBox element.

The LayoutElement.Type property reports the actual type of the PlainTextBox element.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the PlainTextBox class.

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#

layout-api-treeview-example-t239200/CS/LayoutApiSample/Form1.cs#L186

}
protected override void VisitColumnBreakBox(PlainTextBox columnBreakBox)
{

document-layout-api-practical-usage-t266080/CS/WindowsFormsApplication1/DocumentLayoutHelper/DocumentElementLayoutHelper.cs#L13

// get information about a current regular text block
public static string GetInformationAboutRegularTextBlock(PlainTextBox currentTextBlock, Document currentDocument) {
    string returnedInformation = "!A REGULAR TEXT BLOCK IS SELECTED!\r\n";

how-to-create-protected-ranges-in-a-document-depending-on-service-bookmarks-t466775/CS/WindowsFormsApplication1/Form1.cs#L92

public override void DrawPlainTextBox(PlainTextBox plainTextBox) {
    HighlightProtectedRange(plainTextBox.Range, plainTextBox.Bounds);

wpf-rich-editor-layout-api-simple-example-t250783/CS/LayoutAPISimpleExample/MyLayoutPainter.cs#L11

{
    public override void DrawPlainTextBox(PlainTextBox plainTextBox)
    {

layout-api-simple-example-t245818/CS/LayoutApiSimpleExample/MyLayoutPainter.cs#L14

#region #PlainTextBoxPainter
public override void DrawPlainTextBox(PlainTextBox plainTextBox)
{

VB.NET

layout-api-treeview-example-t239200/VB/LayoutApiSample/Form1.vb#L190

End Sub
Protected Overrides Sub VisitColumnBreakBox(ByVal columnBreakBox As PlainTextBox)
    AddTreeNode(columnBreakBox, ContentDisplayAction.Select)

document-layout-api-practical-usage-t266080/VB/WindowsFormsApplication1/DocumentLayoutHelper/DocumentElementLayoutHelper.vb#L16

End Sub
Public Shared Function GetInformationAboutRegularTextBlock(ByVal currentTextBlock As PlainTextBox, ByVal currentDocument As Document) As String
    Dim returnedInformation As String = "!A REGULAR TEXT BLOCK IS SELECTED!" & Constants.vbCrLf

how-to-create-protected-ranges-in-a-document-depending-on-service-bookmarks-t466775/VB/WindowsFormsApplication1/Form1.vb#L98

Public Overrides Sub DrawPlainTextBox(ByVal plainTextBox As PlainTextBox)
    HighlightProtectedRange(plainTextBox.Range, plainTextBox.Bounds)

wpf-rich-editor-layout-api-simple-example-t250783/VB/LayoutAPISimpleExample/MyLayoutPainter.vb#L11

Public Overrides Sub DrawPlainTextBox(ByVal plainTextBox As PlainTextBox)
    If MainWindow.customDrawText = True Then

layout-api-simple-example-t245818/VB/LayoutApiSimpleExample/MyLayoutPainter.vb#L13

#Region "#PlainTextBoxPainter"
Public Overrides Sub DrawPlainTextBox(ByVal plainTextBox As PlainTextBox)
    If Form1.customDrawText = True Then

Implements

RangedLayoutElement

LayoutElement

Inheritance

Object

LayoutElementBase

RangedLayoutElementBase

Box

PlainTextBox