.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
.NET Core 3.0+

PdfAcroFormTextBoxField Class

Represents a text box field.

Namespace: DevExpress.Pdf

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

Declaration

public class PdfAcroFormTextBoxField :
    PdfAcroFormCommonVisualField
Public Class PdfAcroFormTextBoxField
    Inherits PdfAcroFormCommonVisualField
public class PdfAcroFormTextBoxField :
    PdfAcroFormCommonVisualField
Public Class PdfAcroFormTextBoxField
    Inherits PdfAcroFormCommonVisualField
public class PdfAcroFormTextBoxField :
    PdfAcroFormCommonVisualField
Public Class PdfAcroFormTextBoxField
    Inherits PdfAcroFormCommonVisualField

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.

Examples

This example shows how to create text box and radio button group fields and add them to a document.

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");
            }
        }
    }
}
See Also