ShapeCollection.InsertTextBox(DocumentPosition) Method

Inserts a text box.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v19.1.Core.dll

Declaration

C#

Shape InsertTextBox(
    DocumentPosition pos
)

VB.NET

Function InsertTextBox(
    pos As DocumentPosition
) As Shape

Parameters

Name	Type	Description
pos	DocumentPosition	The position of a text box’s anchor.

Returns

Type	Description
Shape	A shape with a text.

Remarks

The InsertTextBox method positions a floating text box at the beginning of the first paragraph on the page that contains the floating object’s anchor.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/word-processing-document-api-examples-t418535

ShapesActions.cs

Document document = server.Document;
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);

ShapesActions.vb

Dim document As Document = server.Document
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)

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the InsertTextBox(DocumentPosition) method.

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#

how-to-add-a-watermark-with-a-text-or-image-to-the-document-e4184/CS/Form1.cs#L29

subDocument.Delete(subDocument.Range);
Shape shape = subDocument.Shapes.InsertTextBox(subDocument.Range.Start);
shape.TextBox.Document.AppendText(text);

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

//Insert a text box to a given position
Shape myTextBox = document.Shapes.InsertTextBox(myPosition);
#endregion #create

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

document.AppendText("Line One\nLine Two\nLine Three");
Shape myTextBox = document.Shapes.InsertTextBox(document.CreatePosition(15));
myTextBox.HorizontalAlignment = ShapeHorizontalAlignment.Center;

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

document.AppendText("Line One\nLine Two\nLine Three");
Shape myTextBox = document.Shapes.InsertTextBox(document.CreatePosition(15));
myTextBox.HorizontalAlignment = ShapeHorizontalAlignment.Center;

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

document.AppendText("Line One\nLine Two\nLine Three");
Shape myTextBox = document.Shapes.InsertTextBox(document.CreatePosition(15));
myTextBox.HorizontalAlignment = ShapeHorizontalAlignment.Center;

VB.NET

how-to-add-a-watermark-with-a-text-or-image-to-the-document-e4184/VB/Form1.vb#L31

subDocument.Delete(subDocument.Range)
Dim shape As Shape = subDocument.Shapes.InsertTextBox(subDocument.Range.Start)
shape.TextBox.Document.AppendText(text)

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

            'Insert a text box to a given position
            Dim myTextBox As Shape = document.Shapes.InsertTextBox(myPosition)
'            #End Region ' #create

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

document.AppendText("Line One" & vbLf & "Line Two" & vbLf & "Line Three")
Dim myTextBox As Shape = document.Shapes.InsertTextBox(document.CreatePosition(15))
myTextBox.HorizontalAlignment = ShapeHorizontalAlignment.Center

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

document.AppendText("Line One" & vbLf & "Line Two" & vbLf & "Line Three")
Dim myTextBox As Shape = document.Shapes.InsertTextBox(document.CreatePosition(15))
myTextBox.HorizontalAlignment = ShapeHorizontalAlignment.Center

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

document.AppendText("Line One" & vbLf & "Line Two" & vbLf & "Line Three")
Dim myTextBox As Shape = document.Shapes.InsertTextBox(document.CreatePosition(15))
myTextBox.HorizontalAlignment = ShapeHorizontalAlignment.Center