Signature Fields

TX Text Control supports signature fields which can be associated with a digital certificate. A signature field can be positioned such as an image or textframe, either geometrically or as a single character. Geometrically, its position can either be relative to a paragraph to which it is anchored or relative to the complete document. The SignatureField class handles the positioning of the signature field in the document. A signature field acts as a site for a signature image. Such an image can be added, when the document is designed or later when it is digitally signed, using the signature field's Image property. When the document is saved as a .pdf document, each signature field can be associated with a digital certificate using the SaveSettings.SignatureFields property. To associate the certificate a signature field must have a name. It can be specified through the field's constructor or its Name property. Additionally, a signature field can store data of an suggested signer which can be set with the SignatureField.SignerData property. All signature fields in a document are contained in a SignatureFieldCollection. The collection can also be used to add or remove signature fields. It can be obtained through the TextControl.SignatureFields, WPF.TextControl.SignatureFields or ServerTextControl.SignatureFields property. The TextControl.SignatureFieldLayoutDialog and WPF.TextControl.SignatureFieldLayoutDialog methods opens a dialog box, which offers layout settings such as positioning, size and text distances and image saving options, when a signature image exists. A signature field can be saved with the TX Text Control format and the .PDF, .DOCX und .RTF formats. With all other formats the signature image is saved. Events occur, when a signature field is created (SignatureFieldCreated), deleted (SignatureFieldDeleted), selected (SignatureFieldSelected) or deselected (SignatureFieldDeselected).

Classes

Class	Description
TXTextControl.SignatureField	An instance of the SignatureField class represents a signature field in a Text Control document.
TXTextControl.SignatureFieldCollection	An instance of the SignatureFieldCollection class contains all signature fields in a Text Control document represented through objects of the type SignatureField.
TXTextControl.SignatureFieldEventArgs	The SignatureFieldEventArgs class provides data for all events that occur with signature fields.
TXTextControl.SignatureImage	An instance of the SignatureImage class represents an image for a SignatureField.
TXTextControl.SignerData	An instance of the SignerData class represents the data of a suggested signer connected with a SignatureField.

Constructors

Constructor	Description
TXTextControl.SignatureField	Initializes a new instance of the SignatureField class.
TXTextControl.SignatureImage	Initializes a new instance of the SignatureImage class.
TXTextControl.SignerData	Initializes a new instance of the SignerData class.

Events

Event	Description
TXTextControl.ServerTextControl.SignatureFieldCreated	Occurs when a new signature field has been created.
TXTextControl.ServerTextControl.SignatureFieldDeleted	Occurs when a signature field has been deleted.

Methods

Method	Description
TXTextControl.ServerTextControl.OnSignatureFieldCreated	Raises the SignatureFieldCreated event.
TXTextControl.ServerTextControl.OnSignatureFieldDeleted	Raises the SignatureFieldDeleted event.
TXTextControl.SignatureFieldCollection.Add	Inserts a new signature field in a Text Control document.
TXTextControl.SignatureFieldCollection.CopyTo	Copies the elements of the collection to an array, starting at a particular index.
TXTextControl.SignatureFieldCollection.GetItem	Gets a particular signature field from the collection.
TXTextControl.SignatureFieldCollection.Remove	Removes a signature field from a Text Control document.

Properties

Property	Description
TXTextControl.ServerTextControl.SignatureFields	Gets a collection of all signature fields contained in the main text of the document.
TXTextControl.SignatureField.Image	Gets or sets a SignatureImage.
TXTextControl.SignatureField.SignerData	Gets or sets a suggested signer's name, title and address and a reason why to sign the document.
TXTextControl.SignatureFieldEventArgs.SignatureField	Gets an object that represents the image which causes the event.
TXTextControl.SignatureImage.ExportCompressionQuality	Sets a value between 1 and 100, which is the quality of a lossy data compression used if this image is saved.
TXTextControl.SignatureImage.ExportFileName	Gets or sets the file name used, if a Text Control document is saved.
TXTextControl.SignatureImage.ExportFilterIndex	Gets or sets the format used if the image is saved.
TXTextControl.SignatureImage.ExportMaxResolution	Gets or sets the maximum resolution in dots per inch used if this image is saved.
TXTextControl.SignatureImage.FileName	Gets or sets the corresponding file name and path from which the image has been loaded.
TXTextControl.SignatureImage.FilterIndex	Gets or sets the format of the image.
TXTextControl.SignatureImage.SaveMode	Determines whether the image is stored through its data or through its file reference.
TXTextControl.SignerData.Name	Gets the name of a suggested signer.
TXTextControl.SignerData.Title	Gets the title of a suggested signer.
TXTextControl.SignerData.Address	Gets the address of a suggested signer.
TXTextControl.SignerData.ContactInfo	Gets contact information of a suggested signer, such as a phone number.
TXTextControl.SignerData.Reason	Gets a reason why the document is signed.