PdfAcroFormTextBoxField Class

Represents a text box field.

Namespace: DevExpress.Pdf

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

Declaration

C#

public class PdfAcroFormTextBoxField :
    PdfAcroFormCommonVisualField

VB.NET

Public Class PdfAcroFormTextBoxField
    Inherits PdfAcroFormCommonVisualField

Related API Members

The following members return PdfAcroFormTextBoxField objects:

• PdfAcroFormField.CreateTextBox(String, Int32, PdfRectangle)

Remarks

To create a text box field, call the PdfAcroFormField.CreateTextBox method with the specified the field name, page number where the field will be added and field rectangle.

Use members of the PdfAcroFormTextBoxField class to specify the text box field properties. For example, you can specify the text box text, and type using PdfAcroFormTextBoxField.Text and PdfAcroFormTextBoxField.Type properties.

To specify the text box name, tooltip and appearance, use the PdfAcroFormField.Name, PdfAcroFormField.ToolTip, and PdfAcroFormVisualField.Appearance properties.

To add text box fields to a document, pass an array of PdfAcroFormTextBoxField objects as a parameter to the PdfDocumentProcessor.AddFormFields method.

To delete a form field from a document using a field name, call the PdfDocumentProcessor.RemoveFormField method.

To delete all interactive elements from a document, call the PdfDocumentProcessor.RemoveForm method.

Example

This example shows how to create interactive form fields (e.g., text box and radio button group fields) and add them to a document.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-add-interactive-form-fields-to-a-document-t494642

Program.vb

Imports DevExpress.Pdf

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

                ' Load a document.
                processor.LoadDocument("..\..\Document.pdf")

                ' Create a text box field specifying the field name, page number, and field location on the page.
                Dim textBox As New PdfAcroFormTextBoxField("text box", 1, New PdfRectangle(230, 690, 280, 710))

                ' Specify text box text, and appearance.
                textBox.Text = "Text Box"
                textBox.Appearance.BackgroundColor = New PdfRGBColor(0.8, 0.5, 0.3)
                textBox.Appearance.FontSize = 12

                ' Create a radio group field specifying its name and the page number.
                Dim radioGroup As New PdfAcroFormRadioGroupField("Gender Group", 1)

                ' Add the first radio button to the group and specify its location using a PdfRectangle object.
                radioGroup.AddButton("button1", New PdfRectangle(230, 635, 250, 655))

                ' Add the second radio button to the group.
                radioGroup.AddButton("button2", New PdfRectangle(310, 635, 330, 655))

                ' Specify radio group selected index, and appearance. 
                radioGroup.SelectedIndex = 0
                radioGroup.Appearance.BorderAppearance = New PdfAcroFormBorderAppearance() With {.Color = New PdfRGBColor(0.8, 0.5, 0.3), .Width = 3}

                ' Add form fields to the page.
                processor.AddFormFields(textBox, radioGroup)

                ' Save the result document.
                processor.SaveDocument("..\..\Result.pdf")
            End Using
        End Sub
    End Class
End Namespace

Program.cs

using DevExpress.Pdf;

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

                // Load a document.
                processor.LoadDocument("..\\..\\Document.pdf");

                // Create a text box field specifying the field name, page number, and field location on the page.
                PdfAcroFormTextBoxField textBox = new PdfAcroFormTextBoxField("text box", 1, new PdfRectangle(230, 690, 280, 710));

                // Specify text box text, and appearance.
                textBox.Text = "Text Box";
                textBox.Appearance.BackgroundColor = new PdfRGBColor(0.8, 0.5, 0.3);
                textBox.Appearance.FontSize = 12;

                // Create a radio group field specifying its name and the page number.
                PdfAcroFormRadioGroupField radioGroup = new PdfAcroFormRadioGroupField("Gender Group", 1);

                // Add the first radio button to the group and specify its location using a PdfRectangle object.
                radioGroup.AddButton("button1", new PdfRectangle(230, 635, 250, 655));

                // Add the second radio button to the group.
                radioGroup.AddButton("button2", new PdfRectangle(310, 635, 330, 655));

                // Specify radio group selected index, and appearance. 
                radioGroup.SelectedIndex = 0;               
                radioGroup.Appearance.BorderAppearance = new PdfAcroFormBorderAppearance() { Color = new PdfRGBColor(0.8, 0.5, 0.3), Width = 3 };

                // Add form fields to the page.
                processor.AddFormFields(textBox, radioGroup);

                // Save the result document.
                processor.SaveDocument("..\\..\\Result.pdf");
            }
        }
    }
}

Inheritance

Object

PdfAcroFormField

PdfAcroFormVisualField

PdfAcroFormCommonVisualField

PdfAcroFormTextBoxField