PdfDocumentProcessor.GetFormData() Method

Returns an object containing values of interactive form data fields.

Namespace: DevExpress.Pdf

Assembly: DevExpress.Docs.v18.2.dll

Declaration

C#

public PdfFormData GetFormData()

VB.NET

Public Function GetFormData As PdfFormData

Returns

Type	Description
PdfFormData	A PdfFormData object.

Remarks

After the interactive form is changed (e.g., using one of the following operations: adding new interactive form fields, interactive form flattening, merging documents with interactive forms, or deleting pages with interactive form fields), the previously obtained interactive form data becomes invalid. To get valid interactive form data from a document, call the GetFormData method again.

Example

The example shows how to fill an existing interactive form using field names.

To obtain interactive form data, call the PdfDocumentProcessor.GetFormData method. Then, specify a value for a form field using the PdfFormData.Value property.

To obtain the names of the interactive form fields, use the PdfDocumentProcessor.GetFormFieldNames method.

To apply data to the interactive form, call the PdfDocumentProcessor.ApplyFormData method.

To learn how to get a checked appearance name for the check box, see the How to: Obtain a Checked Appearance Name for a Check Box example.

To learn how to get a checked appearance name for the radio button, see the How to: Obtain a Checked Appearance Name for Each Radio Button in the Radio Group example.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-programmatically-fill-an-interactive-form-with-values-t210253

PdfFormFilling.vb

' Load a document with an interactive form.
Using documentProcessor As New PdfDocumentProcessor()
    documentProcessor.LoadDocument(filePath & fileName & ".pdf")

    ' Obtain interactive form data from a document.
    Dim formData As PdfFormData = documentProcessor.GetFormData()

    ' Specify the value for FirstName and LastName text boxes.
    formData("FirstName").Value = "Janet"
    formData("LastName").Value = "Leverling"

    ' Specify the value for the Gender radio group.
    formData("Gender").Value = "Female"

    ' Specify the check box checked appearance name.
    formData("Check").Value = "Yes"

    ' Specify values for the Category list box.
    formData("Category").Value = New String() { "Entertainment", "Meals", "Morale" }

    ' Obtain data from the Address form field and specify values for Address child form fields.
    Dim address As PdfFormData = formData("Address")

    ' Specify the value for the Country combo box. 
    address("Country").Value = "United States"

    ' Specify the value for City and Address text boxes. 
    address("City").Value = "California"
    address("Address").Value = "20 Maple Avenue"

    ' Apply data to the interactive form. 
    documentProcessor.ApplyFormData(formData)

    ' Save the modified document.
    documentProcessor.SaveDocument(filePath & fileName & "_new.pdf")

    btnFillFormData.Enabled = False
    btnLoadFilledPDF.Enabled = True
End Using

PdfFormFilling.cs

// Load a document with an interactive form.
using (PdfDocumentProcessor documentProcessor = new PdfDocumentProcessor()) {
    documentProcessor.LoadDocument(filePath + fileName + ".pdf");

    // Obtain interactive form data from a document.
    PdfFormData formData = documentProcessor.GetFormData();

    // Specify the value for FirstName and LastName text boxes.
    formData["FirstName"].Value = "Janet";
    formData["LastName"].Value = "Leverling";

    // Specify the value for the Gender radio group.
    formData["Gender"].Value = "Female";

    // Specify the check box checked appearance name.
    formData["Check"].Value = "Yes";

    // Specify values for the Category list box.
    formData["Category"].Value = new string[] { "Entertainment", "Meals", "Morale" };

    // Obtain data from the Address form field and specify values for Address child form fields.
    PdfFormData address = formData["Address"];

    // Specify the value for the Country combo box. 
    address["Country"].Value = "United States";

    // Specify the value for City and Address text boxes. 
    address["City"].Value = "California";
    address["Address"].Value = "20 Maple Avenue";

    // Apply data to the interactive form. 
    documentProcessor.ApplyFormData(formData);

    // Save the modified document.
    documentProcessor.SaveDocument(filePath + fileName + "_new.pdf");

    btnFillFormData.Enabled = false;
    btnLoadFilledPDF.Enabled = true;
}

Related GitHub Examples

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

pdf-document-api-get-checked-appearance-name-for-check-box/CS/GetCheckboxCheckedValue/Program.cs#L15

// Obtain interactive form data from a document.
PdfFormData formData = processor.GetFormData();

pdf-document-api-fill-interactive-form-fields/CS/PdfFormFilling/PdfFormFilling.cs#L26

// Get names of interactive form fields.
PdfFormData formData = documentProcessor.GetFormData();
IList<string> names = formData.GetFieldNames();

pdf-document-api-get-checked-appearance-name-for-radio-button/CS/Program.cs#L15

// Obtain interactive form data from a document.
PdfFormData formData = processor.GetFormData();

VB.NET

pdf-document-api-get-checked-appearance-name-for-check-box/VB/GetCheckboxCheckedValue/Program.vb#L15

' Obtain interactive form data from a document.
Dim formData As PdfFormData = processor.GetFormData()

pdf-document-api-fill-interactive-form-fields/VB/PdfFormFilling/PdfFormFilling.vb#L26

' Get names of interactive form fields.
Dim formData As PdfFormData = documentProcessor.GetFormData()
Dim names As IList(Of String) = formData.GetFieldNames()

pdf-document-api-get-checked-appearance-name-for-radio-button/VB/Program.vb#L14

' Obtain interactive form data from a document.
Dim formData As PdfFormData = processor.GetFormData()
' Obtain the radio group checked appearance names.