PdfFormData.Value Property

Specifies a value to the interactive form field represented by this PdfFormData object.

Namespace: DevExpress.Pdf

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

Declaration

C#

public object Value { get; set; }

VB.NET

Public Property Value As Object

Property Value

Type	Description
Object	A Object class descendant.

Remarks

The value specified for an interactive form field can be a string for text fields, a name of the checked/unchecked appearance for radio buttons and check boxes, an array of strings (for multi select fields) or a PdfFormData object (for the complex fields for which the field name is provided as a key).

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.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;
}

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

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Value property.

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#L18

// Specify a cheched value for the Female form field obtained from the GetCheckboxCheckedValue method.
formData["Female"].Value = GetCheckboxCheckedValue(processor, "Female");

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

// Specify a checked appearance name for the Female radio button.
formData["Gender"].Value = radioGroupCheckedValues[0];

VB.NET

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

' Specify a cheched value for the Female form field obtained from the GetCheckboxCheckedValue method.
formData("Female").Value = GetCheckboxCheckedValue(processor, "Female")

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

' Specify a checked appearance name for the Female radio button.
formData("Gender").Value = radioGroupCheckedValues(0)
' Apply data to the interactive form.