Available for: UI for ASP.NET Core | UI for ASP.NET MVC | UI for ASP.NET AJAX | UI for Blazor | UI for WPF | UI for WinForms | UI for Silverlight | UI for Xamarin

Form Fields concept

The form fields are the data containers responsible for preserving separate pieces of the interactive form data. There are several types of form fields responsible for preserving different type of data.

FormField Class

FormField class is the base class for all fields. Instances of this class may be found by iterating in the FormFieldCollection of AcroForm.

FormField Properties

The FormField class provides the following properties:

  • FieldType: Provides the FormFieldType of the specifying field instance. This property can be used to easily recognize the type of the concrete field and easily cast the instance to the concrete FormField class inheritor.

  • Name: Provides the name of the field. Each field should have a unique name when added to a FormFieldCollection of an AcroForm. Since R2 2020 you can set the Name as well.

  • UserInterfaceName: Provides name used by the UI when referencing the field. Usually shown in a tooltip when hovering the field representation on the page. Also shown in error messages related to field error calculations.

  • MappingName: Name used when exporting the field data from the document.

  • IsReadOnly: Boolean value indicating whether the field should be threated as read-only in a PDF viewer UI.

  • IsRequired: Boolean value indicating whether the field is required for submitting the interactive form data.

  • ShouldBeSkipped: Boolean value indicating whether the field should be skipped when submitting the form.

  • TextProperties: Represents a VariableTextProperties instance used when creating Widget for visualizing the concrete field. These properties are used to dynamically construct the Widget appearance when it contains some text content.

FormField Types

Each field type can be recognized from the FormField base class by getting the value from its FieldType property. This way you can convert the field to its inheritor type by doing a cast to some of the FormField class inheritors.

Example 1: Obtain fields from a document

using (Stream stream = FileHelper.GetSampleResourceStream("InteractiveForms.pdf")) 
{ 
    RadFixedDocument document = new PdfFormatProvider().Import(stream); 
    foreach (FormField field in document.AcroForm.FormFields) 
    { 
        switch (field.FieldType) 
        { 
            case FormFieldType.TextBox: 
                this.ProcessTextBox((TextBoxField)field); 
                break; 
            case FormFieldType.ListBox: 
                this.ProcessListBox((ListBoxField)field); 
                break; 
            case FormFieldType.RadioButton: 
                this.ProcessRadioButtons((RadioButtonField)field); 
 
                break; 
            case FormFieldType.CheckBox: 
                this.ProcessCheckBoxes((CheckBoxField)field); 
                break; 
        } 
    } 
} 
The following list shows all the inheritors of the FormField class:

Rename Form Fields

In R2 2020 we introduced the Rename method which allows you to rename the Form Fields. You need to pass the existing field name and the new name.

Example 2: Rename Form Fields

public void RenameFields(RadFixedDocument document) 
{ 
    document.AcroForm.FormFields.Rename("OldName", "NewName"); 
} 

Merging Documents with Form Fields

When merging documents that contain FormFields you need to ensure that each field in the document will have unique name. This can be achieved by using the MergedFieldNameResolving event. This event gives you access to all used field names and allow you to change the current field if it is already used.

Example 2: Merge files with Form Fields

public void MergeFields() 
{ 
    PdfFormatProvider provider = new PdfFormatProvider(); 
    var document = provider.Import(File.ReadAllBytes(@"D:\FormFieldDoc.pdf")); 
    var document1 = provider.Import(File.ReadAllBytes(@"D:\FormFieldDoc1.pdf")); 
 
    document.MergedFieldNameResolving += Document_MergedFieldNameResolving; 
 
    document.Merge(document1); 
 
    using (FileStream fs = new FileStream(@"MergedResult.pdf", FileMode.OpenOrCreate)) 
    { 
        provider.Export(document, fs); 
    } 
 
} 
 
private void Document_MergedFieldNameResolving(object sender, MergedFormFieldNameResolvingEventArgs e) 
{ 
    if (e.UsedNames.Contains(e.Name)) 
    { 
        e.NewName = e.Name + "1"; 
    } 
} 

See Also

In this article
Not finding the help you need? Improve this article