SignatureImage Class — TX Text Control .NET Server

Description

An instance of the SignatureImage class represents an image for a SignatureField. It can be specified with the SignatureField.Image property.

Syntax

public class SignatureImage

Public Class SignatureImage

Examples

The following example adds a visible handwritten-signature image to an approval field.

SignatureImage signatureImage = new(@"Images\alex-smith-signature.svg", 0);
SignatureField approval = new(new System.Drawing.Size(3000, 1000), "ApproverSignature", 10) { Image = signatureImage };
textControl.SignatureFields.Add(approval, FrameInsertionMode.AsCharacter);

Dim signatureImage As New SignatureImage("Images\alex-smith-signature.svg", 0)
Dim approval As New SignatureField(New System.Drawing.Size(3000, 1000), "ApproverSignature", 10) With { .Image = signatureImage }
textControl.SignatureFields.Add(approval, FrameInsertionMode.AsCharacter)

Members

Constructors

Constructor	Description
SignatureImage	Initializes a new instance of the SignatureImage class.

Properties

Property	Description
ExportCompressionQuality	Sets a value between 1 and 100, which is the quality of a lossy data compression used if this image is saved. It is only used if the image data is compressed with a lossy compression algorithm. A value of 100 indicates the maximum quality, a value of 1 indicates the minimum quality. If this property is set to zero, which is the default value, Text Control uses the quality value set with the SaveSettings.ImageCompressionQuality property or a compression specific default value.
ExportFileName	Gets or sets the file name used, if a Text Control document is saved. An empty string indicates that no export filename has currently be specified for the image. In this case either the original or a constructed filename is used. A filename is constructed in the following form: <document_filename>_<number>.<extension>
ExportFilterIndex	Gets or sets the format used if the image is saved. This is the number of the filter in the string returned through the ImageCollection.ExportFilters property, beginning with number one. If the ImageCollection.ExportFilters property is used to initialize the FileDialog.Filter property of a Framework dialog, the FileDialog.FilterIndex property can be used as value for this property. A value of zero indicates that no export format has currently be specified for the image. In this case the original format is used that can be obtained with the SignatureImage.FilterIndex property.
ExportMaxResolution	Gets or sets the maximum resolution in dots per inch used if this image is saved. If the image's resolution is larger than this property's value, it is reduced; otherwise, it is not changed. If this property's value is zero, which is the default value, Text Control uses the maximum resolution set with the SaveSettings.ImageMaxResolution property or the image's default resolution.
FileName	Gets or sets the corresponding file name and path from which the image has been loaded.
FilterIndex	Gets or sets the format of the image. This is the number of the filter in the string returned through the ImageCollection.ImportFilters property, beginning with number one. If the ImageCollection.ImportFilters property is used to initialize the FileDialog.Filter property of a Framework dialog, the FileDialog.FilterIndex property can be used as value for this property.
SaveMode	Determines whether the image is stored through its data or through its file reference. By default an image is stored through a file reference if a file reference exists. Otherwise, if the image has been pasted from the clipboard or has been loaded from a data stream, it is stored with its complete binary data.