FormFieldCollection
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:
Methods
Add the specified form field to the collection.
Create a checkbox field with the specified name, add it to the collection, and return it.
public CheckBoxField AddCheckBox(string fieldName)The unique name for the new checkbox field.
Returns:The newly created and added checkbox field.
Create a combo box field with the specified name, add it to the collection, and return it.
public ComboBoxField AddComboBox(string fieldName)The unique name for the new combo box field.
Returns:The newly created and added combo box field.
Create a comb text box field with the specified name, add it to the collection, and return it.
public CombTextBoxField AddCombTextBox(string fieldName)The unique name for the new comb text box field.
Returns:The newly created and added comb text box field.
Create a list box field with the specified name, add it to the collection, and return it.
public ListBoxField AddListBox(string fieldName)The unique name for the new list box field.
Returns:The newly created and added list box field.
Create a push button field with the specified name, add it to the collection, and return it.
public PushButtonField AddPushButton(string fieldName)The unique name for the new push button field.
Returns:The newly created and added push button field.
Create a radio button field with the specified name, add it to the collection, and return it.
public RadioButtonField AddRadioButton(string fieldName)The unique name for the new radio button field.
Returns:The newly created and added radio button field.
Create a signature field with the specified name, add it to the collection, and return it.
public SignatureField AddSignature(string fieldName)The unique name for the new signature field.
Returns:The newly created and added signature field.
Create a text box field with the specified name, add it to the collection, and return it.
public TextBoxField AddTextBox(string fieldName)The unique name for the new text box field.
Returns:The newly created and added text box field.
Return an enumerator that iterates through the form fields.
public IEnumerator<FormField> GetEnumerator()The enumerator.
Implements:
Remove the specified form field from the collection and clean up its event subscriptions.
public void Remove(FormField field)The form field to remove from the collection.
Rename a form field from an old name to a new unique name that meets naming rules.
public void Rename(string oldName, string newName)The current name of the field to rename.
newNamestringThe 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.
Properties
Get the form field with the specified name from the collection.
public FormField this[string fieldName] { get; }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.