FormFieldCollection Class

Description

An instance of the FormFieldCollection class contains all form fields in a Text Control document represented through objects of the types TextFormField, CheckFormField and SelectionFormField. An instance of this class can only be obtained with the TextControl.FormFields property. The FormFieldCollection class implements the IEnumerable and the ICollection interface.

Syntax

public sealed class FormFieldCollection : TextFieldCollectionBase

Public NotInheritable Class FormFieldCollection
    Inherits TextFieldCollectionBase

Examples

The following example works with form fields in the current document.

textControl.Text = "Customer: Contoso Ltd.";
textControl.Select(10, 12);
FormFieldCollection formFieldCollection = textControl.FormFields;
formFieldCollection.Add(new CheckFormField(false) { Name = "AcceptTerms", ID = 100 });

textControl.Text = "Customer: Contoso Ltd."
textControl.Select(10, 12)
Dim formFieldCollection As FormFieldCollection = textControl.FormFields
formFieldCollection.Add(New CheckFormField(False) With { .Name = "AcceptTerms", .ID = 100 })

Members

Properties

Property	Description
CanAdd	Gets a value indicating whether a new text field can be inserted at the current input position. It is true if a text field can be inserted, otherwise it is false. Text Control cannot insert a text field inside of another text field. (Inherited from TextFieldCollectionBase.)
ConditionalInstructions	Gets a collection of all conditional instructions that references to the form fields of the collection. The property's value is an object of type ConditionalInstructionCollection.
Count	Gets the number of elements contained in the collection. (Inherited from TextFieldCollectionBase.)
IsSynchronized	Returns true if the collection is designed to be thread safe, otherwise, it returns false. (Inherited from TextFieldCollectionBase.)
Item	Gets the form field with the specified number from the collection. The number must be between 1 and Count. If the specified index is invalid, null is returned. In C# this property is the indexer for the FormFieldCollection class.
SyncRoot	Gets an object that can be used to synchronize access to the collection. (Inherited from TextFieldCollectionBase.)

Methods

Method	Description
Add	Inserts the specified form field at the current input position.
Clear	Removes all form fields from a Text Control document.
CopyTo	Copies the elements of the collection to an array, starting at a particular index.
GetEnumerator	Returns an enumerator that can be used to iterate through the collection. (Inherited from TextFieldCollectionBase.)
GetItem	Gets a particular form field from the collection.
Remove	Removes the specified form field from a Text Control document.