SignatureFieldCollection Class
- Namespace
TXTextControl
- Package
TXTextControl.from the private NuGet feed or Text Control Offline PackagesTextControl. WinForms. SDK
- Assembly
TXTextControl.dll
- Install
dotnet add package TXTextControl..NET 8 and later. For .NET Framework, referenceTextControl. WinForms. SDK TXTextControl.from the setup.dll
- Inherits
- Frame
Base Collection - Signature
Field Collection
- Frame
- Implements
- ICollection, IEnumerable
Description
An instance of the SignatureFieldCollection class contains all signature fields in a Text Control document represented through objects of the type SignatureField. An instance of this class can be obtained with the TextControl.SignatureFields, WPF.TextControl.SignatureFields and ServerTextControl.SignatureFields property. The SignatureFieldCollection class implements the IEnumerable and the ICollection interfaces.
Syntax
public sealed class SignatureFieldCollection : FrameBaseCollectionPublic NotInheritable Class SignatureFieldCollection
Inherits FrameBaseCollectionExamples
The following example works with signature fields in the current document.
SignatureFieldCollection signatureFieldCollection = textControl.SignatureFields;
signatureFieldCollection.Add(new SignatureField(new System.Drawing.Size(3000, 1000), "ApproverSignature", 100), FrameInsertionMode.AsCharacter);Dim signatureFieldCollection As SignatureFieldCollection = textControl.SignatureFields
signatureFieldCollection.Add(New SignatureField(New System.Drawing.Size(3000, 1000), "ApproverSignature", 100), FrameInsertionMode.AsCharacter)Members
Properties
| Property | Description |
|---|---|
| Count | Gets the number of elements contained in the collection. (Inherited from FrameBaseCollection.) |
| IsSynchronized | Returns true if the collection is designed to be thread safe, otherwise, it returns false. (Inherited from FrameBaseCollection.) |
| SyncRoot | Gets an object that can be used to synchronize access to the collection. (Inherited from FrameBaseCollection.) |
Methods
| Method | Description |
|---|---|
| Add | Inserts a new signature field in a Text Control document. |
| Clear | Removes all objects from the collection and from the document. (Inherited from FrameBaseCollection.) |
| 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 FrameBaseCollection.) |
| GetItem | Gets a particular signature field from the collection. |
| Remove | Removes a signature field from a Text Control document. |