TX Text Control .NET for Windows Forms

FieldAdapterCollection Class

Class|Introduced in 15.0
Namespace
TXTextControl.DocumentServer
Package
TXTextControl.TextControl.WinForms.SDK from the private NuGet feed or Text Control Offline Packages
Assembly
TXDocumentServer.dll
Install
dotnet add package TXTextControl.TextControl.WinForms.SDK .NET 8 and later. For .NET Framework, reference TXDocumentServer.dll from the setup.
Implements
ICollection, IEnumerable

Description

An instance of the FieldAdapterCollection class contains adapters for all application fields of the page it belongs to. An instance of this class can be obtained via the DocumentController.Page.FieldAdapters property. The FieldAdapterCollection that can be accessed via the DocumentController.FieldAdapters property contains adapters for all the application fields in the currently loaded document, of course. The FieldAdapterCollection class implements the IEnumerable and the ICollection interfaces and is part of the TXTextControl.DocumentServer.DocumentController namespace.

Syntax

public sealed class DocumentController.FieldAdapterCollection : ICollection, IEnumerable

Examples

The following example creates a Field Adapter Collection instance for a document-processing operation. The created object is then available to the surrounding document workflow.

TXTextControl.DocumentServer.DocumentController.FieldAdapterCollection fieldAdapterCollection = new(new UserDefinedPropertyDictionary(), new ServerTextControl());
Console.WriteLine("Field Adapter Collection is ready for use.");

Members

Constructors

ConstructorDescription
FieldAdapterCollectionNot described in the reference. public FieldAdapterCollection(ICollection appFields, ServerTextControl txServer);

Properties

PropertyDescription
CountGets the number of elements contained in the collection.
IsSynchronizedNot described in the reference. public bool IsSynchronized { get; }
ItemGets the DocumentServer.Fields.FieldAdapter instance at the specified index from the collection. In C# this property is the indexer for the FieldAdapterCollection class.
SyncRootNot described in the reference. public object SyncRoot { get; }

Methods

MethodDescription
CopyToCopies the elements of the collection to an array, starting at the specified index.
GetEnumeratorReturns an enumerator that can be used to iterate over the collection's items.
IndexOfGets the index of the specified field adapter in the collection.