.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+

PdfDocumentProcessor.GetFormData() Method

Returns an object containing values of interactive form data fields.

Namespace: DevExpress.Pdf

Assembly: DevExpress.Docs.v21.2.dll

Declaration

public PdfFormData GetFormData()

Returns

Type Description
PdfFormData

A PdfFormData object.

Remarks

After the interactive form is changed, previously obtained interactive form data becomes invalid. The following operations change the interactive form:

  • add new fields;
  • flatten the form;
  • merge documents with interactive forms;
  • delete pages with interactive form fields.

Call the GetFormData method again to get valid interactive form data.

Example

The code sample below uses PdfFormData to set form field values:

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

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.

See Also