Class FormFieldCollection

Collection for managing interactive form fields in a PDF document; add, remove, look up by name, and enumerate fields.

Inheritance

System.Object

FormFieldCollection

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Telerik.Windows.Documents.Fixed.Model.InteractiveForms

Assembly: Telerik.Windows.Documents.Fixed.dll

Syntax

public class FormFieldCollection : IEnumerable<FormField>, IEnumerable

Properties

Count

The number of form fields contained in the collection.

Declaration

public int Count { get; }

Property Value

System.Int32

Item[String]

Get the form field with the specified name from the collection.

Declaration

public FormField this[string fieldName] { get; }

Parameters

System.String fieldName The unique name of the form field to retrieve.

Property Value

FormField The form field with the specified name.

Exceptions

System.Collections.Generic.KeyNotFoundException 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

FormField 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

System.String fieldName The unique name for the new checkbox field.

Returns

CheckBoxField The newly created and added checkbox 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

System.String fieldName The unique name for the new combo box field.

Returns

ComboBoxField The newly created and added combo box 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

System.String fieldName The unique name for the new comb text box field.

Returns

CombTextBoxField The newly created and added comb text 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

System.String fieldName The unique name for the new list box field.

Returns

ListBoxField 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

System.String fieldName The unique name for the new push button field.

Returns

PushButtonField 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

System.String fieldName The unique name for the new radio button field.

Returns

RadioButtonField 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

System.String fieldName The unique name for the new signature field.

Returns

SignatureField 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

System.String fieldName The unique name for the new text box field.

Returns

TextBoxField The newly created and added text box field.

Contains(String)

Return whether a field with the specified name exists in the collection.

Declaration

public bool Contains(string fieldName)

Parameters

System.String fieldName Name of the field.

Returns

System.Boolean true if a field with the specified name exists; otherwise, false.

GetEnumerator()

Return an enumerator that iterates through the form fields.

Declaration

public IEnumerator<FormField> GetEnumerator()

Returns

System.Collections.Generic.IEnumerator<FormField> The enumerator.

Implements

System.Collections.Generic.IEnumerable<T>.GetEnumerator()

Remove(FormField)

Remove the specified form field from the collection and clean up its event subscriptions.

Declaration

public void Remove(FormField field)

Parameters

FormField 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

System.String oldName The current name of the field to rename.

System.String newName The new name to assign to the field.

Exceptions

System.ArgumentException 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.

Explicit Interface Implementations

IEnumerable.GetEnumerator()

Gets the enumerator for the elements in the collection.

Declaration

IEnumerator IEnumerable.GetEnumerator()

Returns

System.Collections.IEnumerator An enumerator that can be used to iterate through the form fields in the collection.

Implements

System.Collections.IEnumerable.GetEnumerator()