TX Text Control .NET for Windows Forms

SignatureField Class

Class|Introduced in 31.0
Namespace
TXTextControl
Package
TXTextControl.TextControl.WinForms.SDK from the private NuGet feed or Text Control Offline Packages
Assembly
TXTextControl.dll
Install
dotnet add package TXTextControl.TextControl.WinForms.SDK .NET 8 and later. For .NET Framework, reference TXTextControl.dll from the setup.
Inherits
  1. FrameBase
  2. SignatureField

Description

An instance of the SignatureField class represents a signature field in a Text Control document. A signature field is a frame which can be inserted in a document and that acts as a site for a signature image. An image can be added, when the document is designed or later when it is digitally signed. When the document is saved as a .pdf document, each signature field can be associated with a digital certificate using the SaveSettings.SignatureFields property.

Syntax

public class SignatureField : FrameBase

Examples

The following example adds a named signature field to the document.

SignatureField signatureField = new(new System.Drawing.Size(3000, 1000), "ApproverSignature", 10);
textControl.SignatureFields.Add(signatureField, FrameInsertionMode.AsCharacter);

Members

Constructors

ConstructorDescription
SignatureFieldInitializes a new instance of the SignatureField class. A name is necessary when the signature field is associated with a digital certificate.

Properties

PropertyDescription
AlignmentGets or sets the frame's horizontal alignment when it is anchored to a paragraph. (Inherited from FrameBase.)
BoundsGets the frame's bounding rectangle relative to the upper left corner of the document. (Inherited from FrameBase.)
DescriptiveTextGets or sets a descriptive text for the frame. An empty string indicates that the frame has no such text. An empty string can also be used to delete a previously set text. (Inherited from FrameBase.)
IDGets or sets an identifier for the frame. It must be a one-based value. A value of zero indicates that the image, text frame, chart, barcode or drawing has no identifier. Zero can also be used to delete a previously set identifier. (Inherited from FrameBase.)
ImageGets or sets a SignatureImage. The property's value is null, when the signature field has no signature image. When the property is set to null, a previously inserted image is removed.
InsertionModeGets or sets a value determining whether the frame is treated as a single character or the document's text either flows around or overwrites the frame. If the document's text flows around or overwrites the frame, this property also determines whether the image, text frame, chart, barcode or drawing is moved with the text or fixed positioned on a page. (Inherited from FrameBase.)
LocationGets or sets, in twips, the frame's current location. If the image, text frame, chart, barcode or drawing is anchored to a paragraph, the location is relative to the paragraph. Otherwise, it is relative to the document. If the frame has a horizontal alignment or if it is inserted inline, this property returns zero. This property cannot be set for images, text frames, charts, barcodes or drawings which are inserted inline. (Inherited from FrameBase.)
MoveableDetermines whether a frame can be moved in the document at run time with the built-in mouse interface. (Inherited from FrameBase.)
NameGets or sets a name for the frame. An empty string indicates that the frame has no name. An empty string can also be used to delete a previously set name. (Inherited from FrameBase.)
SignerDataGets or sets a suggested signer's name, title and address and a reason why to sign the document. The property's value is an object of the type SignerData.
SizeGets or sets the frame's size in twips. For images this property is read only. (Inherited from FrameBase.)
SizeableDetermines whether the frame can be resized at run time with the built-in mouse interface. (Inherited from FrameBase.)
TextDistancesGets or sets the distances, in twips, between the frame and the document's text. The property's value is an array of four variables specifying the distances in the following order: left, top, right and bottom. If a value is set to -1, it is not changed. (Inherited from FrameBase.)
TextPositionRead only. Gets the frame's character position in the document's text (one-based). (Inherited from FrameBase.)

Methods

MethodDescription
ChangeZOrderChanges the frame's z-order. (Inherited from FrameBase.)