PdfGraphicsAcroFormTextBoxField.Text Property

Specifies text of the text box field.

Namespace: DevExpress.Pdf

Assembly: DevExpress.Pdf.v19.1.Drawing.dll

Declaration

C#

public string Text { get; set; }

VB.NET

Public Property Text As String

Property Value

Type	Description
String	A String value which represents the text displayed in the text box field.

Example

This example shows how to create a text box field and add it to a document.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-add-a-text-box-field-to-a-document-t494157

Program.cs

using DevExpress.Pdf;
using System.Drawing;

namespace AddTextBoxField {
    class Program {
        static void Main(string[] args) {
            using (PdfDocumentProcessor processor = new PdfDocumentProcessor()) {

                // Create an empty document. 
                processor.CreateEmptyDocument("..\\..\\Result.pdf");

                // Create and draw a text box field.
                using (PdfGraphics graphics = processor.CreateGraphics()) {
                    DrawTextBoxField(graphics);

                    // Render a page with graphics.
                    processor.RenderNewPage(PdfPaperSize.Letter, graphics);
                }
            }
        }

        static void DrawTextBoxField(PdfGraphics graphics) {

            // Create a text box field and specify its location on the page using a RectangleF object.
            PdfGraphicsAcroFormTextBoxField textBox = new PdfGraphicsAcroFormTextBoxField("text box", new RectangleF(0, 10, 200, 30));

            // Specify text box properties.
            textBox.Text = "Text Box";           
            textBox.TextAlignment = PdfAcroFormStringAlignment.Near;
            textBox.Appearance.FontSize = 12;
            textBox.Appearance.BackgroundColor = Color.AliceBlue;          

            // Add the field to graphics.
            graphics.AddFormField(textBox);
        }
    }
}

Program.vb

Imports DevExpress.Pdf
Imports System.Drawing

Namespace AddTextBoxField
    Friend Class Program
        Shared Sub Main(ByVal args() As String)
            Using processor As New PdfDocumentProcessor()

                ' Create an empty document. 
                processor.CreateEmptyDocument("..\..\Result.pdf")

                ' Create and draw a text box field.
                Using graphics As PdfGraphics = processor.CreateGraphics()
                    DrawTextBoxField(graphics)

                    ' Render a page with graphics.
                    processor.RenderNewPage(PdfPaperSize.Letter, graphics)
                End Using
            End Using
        End Sub

        Private Shared Sub DrawTextBoxField(ByVal graphics As PdfGraphics)

            ' Create a text box field and specify its location on the page using a RectangleF object.
            Dim textBox As New PdfGraphicsAcroFormTextBoxField("text box", New RectangleF(0, 10, 200, 30))

            ' Specify text box properties.
            textBox.Text = "Text Box"
            textBox.TextAlignment = PdfAcroFormStringAlignment.Near
            textBox.Appearance.FontSize = 12
            textBox.Appearance.BackgroundColor = Color.AliceBlue

            ' Add the field to graphics.
            graphics.AddFormField(textBox)
        End Sub
    End Class
End Namespace

Related GitHub Examples

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

pdf-document-api-create-text-box-field/CS/AddTextBoxField/Program.cs#L28

// Specify text box properties.
textBox.Text = "Text Box";
textBox.TextAlignment = PdfAcroFormStringAlignment.Near;

VB.NET

pdf-document-api-create-text-box-field/VB/AddTextBoxField/Program.vb#L25

' Specify text box properties.
textBox.Text = "Text Box"
textBox.TextAlignment = PdfAcroFormStringAlignment.Near

pdf-document-api-create-interactive-form/VB/AddFormFieldsToNewDocument/Program.vb#L25

' Specify text box text, and appearance.
textBox.Text = "Text Box"
textBox.Appearance.FontSize = 12