Description

An instance of the TextFieldCollection class contains all standard text fields in a Text Control document or part of the document represented through objects of the type TextField. An instance of this class can be obtained with the TextControl.TextFields, HeaderFooter.TextFields or TextFrame.TextFields property. The TextFieldCollection class implements the IEnumerable and the ICollection interface. For more information see the technical article Text Fields and Hypertext Links.

Syntax

public sealed class TextFieldCollection : TextFieldCollectionBase

Public NotInheritable Class TextFieldCollection
    Inherits TextFieldCollectionBase

Examples

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

textControl.Text = "Customer: Contoso Ltd.";
textControl.Select(10, 12);
TextFieldCollection textFieldCollection = textControl.TextFields;
textFieldCollection.Add(new ApplicationField(ApplicationFieldFormat.MSWord, "MERGEFIELD", "Customer name", new[] { "CustomerName" }) { ID = 100 });

textControl.Text = "Customer: Contoso Ltd."
textControl.Select(10, 12)
Dim textFieldCollection As TextFieldCollection = textControl.TextFields
textFieldCollection.Add(New ApplicationField(ApplicationFieldFormat.MSWord, "MERGEFIELD", "Customer name", New String() { "CustomerName" }) With { .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.)
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 field with the specified number from the collection. The number must be between 1 and Count. In C# this property is the indexer for the TextFieldCollection class.
SyncRoot	Gets an object that can be used to synchronize access to the collection. (Inherited from TextFieldCollectionBase.)

Methods

Method	Description
Add	Inserts a new standard text field at the current input position.
Clear	Removes all text 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 text field from the collection.
Remove	Removes a text field from a Text Control document.

TextFieldCollection Class