TextBox.Document Property

Provides access to content of the text box.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

SubDocument Document { get; }

VB.NET

ReadOnly Property Document As SubDocument

Property Value

Type	Description
SubDocument	A SubDocument interface exposing the text box content.

Remarks

The following code snippet illustrate how you can modify the text box content programmatically.

The following code inserts a paragraph and a picture from the main document into the text box. The TextBox.Document property provides access to the text box content.

C#

document.AppendText("Line One\nLine Two\nLine Three");
Shape myPicture = document.Shapes.InsertPicture(document.CreatePosition(15), 
    System.Drawing.Image.FromFile("beverages.png"));
myPicture.HorizontalAlignment = ShapeHorizontalAlignment.Center;

VB.NET

document.AppendText("Line One" & vbLf & "Line Two" & vbLf & "Line Three")
Dim myPicture As Shape = document.Shapes.InsertPicture(document.CreatePosition(15), System.Drawing.Image.FromFile("beverages.png"))
myPicture.HorizontalAlignment = ShapeHorizontalAlignment.Center

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Document 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#L73

// Modify text box content.
SubDocument textBoxDocument = myTextBox.TextBox.Document;
textBoxDocument.AppendText("TextBox Text");

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

// Modify text box content.
SubDocument textBoxDocument = myTextBox.TextBox.Document;
textBoxDocument.AppendText("TextBox Text");

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

// Modify text box content.
SubDocument textBoxDocument = myTextBox.TextBox.Document;
textBoxDocument.AppendText("TextBox Text");

text-boxes-simple-example-t481625/CS/TextBoxes/Form1.cs#L38

//Access the text box content
SubDocument textBoxDocument = document.Shapes[0].TextBox.Document;

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

        if (shape.TextBox != null)
            subDocumentProcessor(shape.TextBox.Document);
}

VB.NET

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

' Modify text box content.
Dim textBoxDocument As SubDocument = myTextBox.TextBox.Document
textBoxDocument.AppendText("TextBox Text")

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

' Modify text box content.
Dim textBoxDocument As SubDocument = myTextBox.TextBox.Document
textBoxDocument.AppendText("TextBox Text")

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

' Modify text box content.
Dim textBoxDocument As SubDocument = myTextBox.TextBox.Document
textBoxDocument.AppendText("TextBox Text")

text-boxes-simple-example-t481625/VB/TextBoxes/Form1.vb#L34

'Access the text box content
Dim textBoxDocument As SubDocument = document.Shapes(0).TextBox.Document

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

If shape.TextBox IsNot Nothing Then
    subDocumentProcessor(shape.TextBox.Document)
End If