Documentation

Class FormFieldCollection

Represents a collection of document 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

Gets the count of the fields in the collection.

Declaration
public int Count { get; }
Property Value
System.Int32

Item[String]

Gets FormField instance by field name.

Declaration
public FormField this[string fieldName] { get; }
Parameters
System.String fieldName

The field name.
Property Value
FormField

Methods

Add(FormField)

Adds field to the collection.

Declaration
public void Add(FormField field)
Parameters
FormField field

The field to be added.

AddCheckBox(String)

Creates new CheckBoxField and adds it to the collection.

Declaration
public CheckBoxField AddCheckBox(string fieldName)
Parameters
System.String fieldName

The field name.
Returns
CheckBoxField

The result field.

AddComboBox(String)

Creates new ComboBoxField and adds it to the collection.

Declaration
public ComboBoxField AddComboBox(string fieldName)
Parameters
System.String fieldName

The field name.
Returns
ComboBoxField

The result field.

AddCombTextBox(String)

Creates new CombTextBoxField and adds it to the collection.

Declaration
public CombTextBoxField AddCombTextBox(string fieldName)
Parameters
System.String fieldName

The field name.
Returns
CombTextBoxField

The result field.

AddListBox(String)

Creates new ListBoxField and adds it to the collection.

Declaration
public ListBoxField AddListBox(string fieldName)
Parameters
System.String fieldName

The field name.
Returns
ListBoxField

The result field.

AddPushButton(String)

Creates new PushButtonField and adds it to the collection.

Declaration
public PushButtonField AddPushButton(string fieldName)
Parameters
System.String fieldName

The field name.
Returns
PushButtonField

The result field.

AddRadioButton(String)

Creates new RadioButtonField and adds it to the collection.

Declaration
public RadioButtonField AddRadioButton(string fieldName)
Parameters
System.String fieldName

The field name.
Returns
RadioButtonField

The result field.

AddSignature(String)

Creates new SignatureField and adds it to the collection.

Declaration
public SignatureField AddSignature(string fieldName)
Parameters
System.String fieldName

The field name.
Returns
SignatureField

The result field.

AddTextBox(String)

Creates new TextBoxField and adds it to the collection.

Declaration
public TextBoxField AddTextBox(string fieldName)
Parameters
System.String fieldName

The field name.
Returns
TextBoxField

The result field.

Contains(String)

Determines whether this instance contains the object.

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()

Gets the enumerator for the elements in the collection.

Declaration
public IEnumerator<FormField> GetEnumerator()
Returns
System.Collections.Generic.IEnumerator<FormField>

The enumerator.
Implements
System.Collections.Generic.IEnumerable<T>.GetEnumerator()

Remove(FormField)

Removes field from the collection.

Declaration
public void Remove(FormField field)
Parameters
FormField field

The field to be removed.

Rename(String, String)

Renames field with a specified name.

Declaration
public void Rename(string oldName, string newName)
Parameters
System.String oldName

The old name of the field.
System.String newName

The new name.
Exceptions
System.ArgumentException

Name cannot be empty. or Could not find a field with the specified name. - oldName or The specified name is already used by another field. - newName or Name cannot contain .(period). - newName

Explicit Interface Implementations

IEnumerable.GetEnumerator()

Gets the enumerator for the elements in the collection.

Declaration
IEnumerator IEnumerable.GetEnumerator()
Returns
System.Collections.IEnumerator

Implements
System.Collections.IEnumerable.GetEnumerator()