PdfDocumentProcessor.AddFormFields(PdfAcroFormField[]) Method

Adds interactive form fields to a PDF document.

Namespace: DevExpress.Pdf

Assembly: DevExpress.Docs.v18.2.dll

Declaration

C#

public void AddFormFields(
    params PdfAcroFormField[] fields
)

VB.NET

Public Sub AddFormFields(
    ParamArray fields As PdfAcroFormField()
)

Parameters

Name	Type	Description
fields	PdfAcroFormField[]	A PdfAcroFormField array containing form fields that should be added to a PDF document.

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

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the AddFormFields(PdfAcroFormField[]) 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.

VB.NET

pdf-document-api-add-interactive-form-fields-to-document/VB/AddFormFieldsToExistingDocument/Program.vb#L27

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