ClassFormFieldCollection
Collection for managing interactive form fields in a PDF document; add, remove, look up by name, and enumerate fields.
Definition
Namespace:Telerik.Windows.Documents.Fixed.Model.InteractiveForms
Assembly:Telerik.Windows.Documents.Fixed.dll
Syntax:
public class FormFieldCollection : IEnumerable<FormField>, IEnumerableInheritance: objectFormFieldCollection
Implements:
Properties
Count
The number of form fields contained in the collection.
this[string]
Get the form field with the specified name from the collection.
Declaration
public FormField this[string fieldName] { get; }Parameters
fieldName
The unique name of the form field to retrieve.
Property Value
The form field with the specified name.
Exceptions
Thrown when no field with the specified name exists in the collection.
Methods
Add(FormField)
Add the specified form field to the collection.
Declaration
public void Add(FormField field)Parameters
field
The field to be added.
AddCheckBox(string)
Create a checkbox field with the specified name, add it to the collection, and return it.
Declaration
public CheckBoxField AddCheckBox(string fieldName)Parameters
fieldName
The unique name for the new checkbox field.
Returns
The newly created and added checkbox field.
AddCombTextBox(string)
Create a comb text box field with the specified name, add it to the collection, and return it.
Declaration
public CombTextBoxField AddCombTextBox(string fieldName)Parameters
fieldName
The unique name for the new comb text box field.
Returns
The newly created and added comb text box field.
AddComboBox(string)
Create a combo box field with the specified name, add it to the collection, and return it.
Declaration
public ComboBoxField AddComboBox(string fieldName)Parameters
fieldName
The unique name for the new combo box field.
Returns
The newly created and added combo box field.
AddListBox(string)
Create a list box field with the specified name, add it to the collection, and return it.
Declaration
public ListBoxField AddListBox(string fieldName)Parameters
fieldName
The unique name for the new list box field.
Returns
The newly created and added list box field.
AddPushButton(string)
Create a push button field with the specified name, add it to the collection, and return it.
Declaration
public PushButtonField AddPushButton(string fieldName)Parameters
fieldName
The unique name for the new push button field.
Returns
The newly created and added push button field.
AddRadioButton(string)
Create a radio button field with the specified name, add it to the collection, and return it.
Declaration
public RadioButtonField AddRadioButton(string fieldName)Parameters
fieldName
The unique name for the new radio button field.
Returns
The newly created and added radio button field.
AddSignature(string)
Create a signature field with the specified name, add it to the collection, and return it.
Declaration
public SignatureField AddSignature(string fieldName)Parameters
fieldName
The unique name for the new signature field.
Returns
The newly created and added signature field.
AddTextBox(string)
Create a text box field with the specified name, add it to the collection, and return it.
Declaration
public TextBoxField AddTextBox(string fieldName)Parameters
fieldName
The unique name for the new text box field.
Returns
The newly created and added text box field.
Contains(string)
Return whether a field with the specified name exists in the collection.
GetEnumerator()
Return an enumerator that iterates through the form fields.
Declaration
public IEnumerator<FormField> GetEnumerator()Returns
The enumerator.
Implements
Remove(FormField)
Remove the specified form field from the collection and clean up its event subscriptions.
Declaration
public void Remove(FormField field)Parameters
field
The form field to remove from the collection.
Rename(string, string)
Rename a form field from an old name to a new unique name that meets naming rules.
Declaration
public void Rename(string oldName, string newName)Parameters
oldName
The current name of the field to rename.
newName
The new name to assign to the field.
Exceptions
Thrown when the old name or new name is null or empty, when no field with the old name exists, when the new name is already used by another field, or when the new name contains a period character.