ApplicationFieldCollection Class — TX Text Control .NET Server

Description

An instance of the ApplicationFieldCollection class contains all created or imported Microsoft Word or Heiler HighEdit fields represented through objects of the type ApplicationField. An instance of this class can be obtained with the TextControl.ApplicationFields property. The collection can contain fields in different formats. Currently supported formats are Microsoft Word fields and Heiler HighEdit fields. The ApplicationFieldCollection class implements the IEnumerable and the ICollection interfaces. For more information see the technical article Text Fields and Hypertext Links - Importing Fields from Microsoft Word.

Syntax

public sealed class ApplicationFieldCollection : TextFieldCollectionBase

Public NotInheritable Class ApplicationFieldCollection
    Inherits TextFieldCollectionBase

Examples

The following example iterates through all fields and sets the visible text of the address field:

foreach (TXTextControl.ApplicationField myApplicationField in textControl1.ApplicationFields)
{
    if (myApplicationField.TypeName == "MERGEFIELD" && myApplicationField.Parameters[0] == "Address")
    {
        myApplicationField.Text = "Bakerstreet, London";
    }
}

For Each MyApplicationField As TXTextControl.ApplicationField In TextControl1.ApplicationFields
    If MyApplicationField.TypeName = "MERGEFIELD" And MyApplicationField.Parameters(0) = "Address" Then
        MyApplicationField.Text = "Bakerstreet, London"
    End If
Next

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

textControl.Text = "Customer: Contoso Ltd.";
textControl.Select(10, 12);
ApplicationFieldCollection applicationFieldCollection = textControl.ApplicationFields;
ApplicationField field = new(ApplicationFieldFormat.MSWord, "MERGEFIELD", "Customer name", new[] { "CustomerName" });
applicationFieldCollection.Add(field);

textControl.Text = "Customer: Contoso Ltd."
textControl.Select(10, 12)
Dim applicationFieldCollection As ApplicationFieldCollection = textControl.ApplicationFields
Dim field As New ApplicationField(ApplicationFieldFormat.MSWord, "MERGEFIELD", "Customer name", New String() { "CustomerName" })
applicationFieldCollection.Add(field)

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 ApplicationFieldCollection 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 object of the type ApplicationField at the current input position.
Clear	Removes all fields of the type ApplicationField from a TX 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 field of the type ApplicationField from the collection.
Remove	Removes a field of the type ApplicationField from a TX Text Control document.