Shape.TextBox Property

Provides access to text box content.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

TextBox TextBox { get; }

VB.NET

ReadOnly Property TextBox As TextBox

Property Value

Type	Description
TextBox	A SubDocument interface that exposes the content of a text box.

Remarks

The following code snippet inserts a text box in the document, adjusts its appearance and formats the text in the text box.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/winforms-richedit-document-api-e5219

Shapes.vb

document.AppendText("Line One" & vbLf & "Line Two" & vbLf & "Line Three")
Dim myTextBox As Shape = document.Shapes.InsertTextBox(document.CreatePosition(15))
myTextBox.HorizontalAlignment = ShapeHorizontalAlignment.Center
' Specify the text box background color.
myTextBox.Fill.Color = System.Drawing.Color.WhiteSmoke
' Draw a border around the text box.
myTextBox.Line.Color = System.Drawing.Color.Black
myTextBox.Line.Thickness = 1
' Modify text box content.
Dim textBoxDocument As SubDocument = myTextBox.TextBox.Document
textBoxDocument.AppendText("TextBox Text")
Dim cp As CharacterProperties = textBoxDocument.BeginUpdateCharacters(textBoxDocument.Range.Start, 7)
cp.ForeColor = System.Drawing.Color.Orange
cp.FontSize = 24
textBoxDocument.EndUpdateCharacters(cp)

Shapes.cs

document.AppendText("Line One\nLine Two\nLine Three");
Shape myTextBox = document.Shapes.InsertTextBox(document.CreatePosition(15));
myTextBox.HorizontalAlignment = ShapeHorizontalAlignment.Center;
// Specify the text box background color.
myTextBox.Fill.Color = System.Drawing.Color.WhiteSmoke;
// Draw a border around the text box.
myTextBox.Line.Color = System.Drawing.Color.Black;
myTextBox.Line.Thickness = 1;
// Modify text box content.
SubDocument textBoxDocument = myTextBox.TextBox.Document;
textBoxDocument.AppendText("TextBox Text");
CharacterProperties cp = textBoxDocument.BeginUpdateCharacters(textBoxDocument.Range.Start, 7);
cp.ForeColor = System.Drawing.Color.Orange;
cp.FontSize = 24;
textBoxDocument.EndUpdateCharacters(cp);

Related GitHub Examples

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

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#

wpf-richedit-document-api-t213968/CS/DXRichEditControlAPISample/CodeExamples/ShapesActions.cs#L108

// Rotate a text box and resize a floating picture.
   if (s.TextBox == null)
   {

winforms-richedit-document-api-e5219/CS/RichEditAPISample/CodeExamples/Shapes.cs#L97

// Rotate a text box and resize a floating picture.
   if (s.TextBox == null)
   {

word-document-api-examples/CS/CodeExamples/ShapesActions.cs#L105

// Rotate a text box and resize a floating picture.
if (s.TextBox == null)
{

How-to-iterate-through-all-SubDocuments/CS/SubDocumentIterator/SubDocumentHelper.cs#L45

foreach (Shape shape in shapes)
    if (shape.TextBox != null)
        subDocumentProcessor(shape.TextBox.Document);

VB.NET

wpf-richedit-document-api-t213968/VB/DXRichEditControlAPISample/CodeExamples/ShapesActions.vb#L96

' Rotate a text box and resize a floating picture.
   If s.TextBox Is Nothing Then
       s.ScaleX = 0.1F

winforms-richedit-document-api-e5219/VB/RichEditAPISample/CodeExamples/Shapes.vb#L87

' Rotate a text box and resize a floating picture.
   If s.TextBox Is Nothing Then
       s.ScaleX = 0.1F

word-document-api-examples/VB/CodeExamples/ShapesActions.vb#L95

' Rotate a text box and resize a floating picture.
If s.TextBox Is Nothing Then
    s.ScaleX = 0.1F

How-to-iterate-through-all-SubDocuments/VB/SubDocumentIterator/SubDocumentHelper.vb#L38

For Each shape As Shape In shapes
    If shape.TextBox IsNot Nothing Then
        subDocumentProcessor(shape.TextBox.Document)