TX Text Control .NET for Windows Forms

ExportFilterIndex Property

Property|Introduced in 31.0
Namespace
TXTextControl
Package
TXTextControl.TextControl.WinForms.SDK as TXTextControl.dll from the private NuGet feed or Text Control Offline Packages

Description

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.

Syntax

public int ExportFilterIndex { get; set; }

Members

ValueDescription
1Windows Bitmap (.BMP)
2Windows Metafile (.WMF)
3Portable Network Graphics (.PNG)
4JPEG File Interchange Format (.JPG, .JPEG)
5Windows Enhanced Metafile (.EMF)
6Tagged Image Format (.TIF)
7Graphics Interchange Format (.GIF)

Examples

The following example adds a visible handwritten-signature image to an approval field by using SignatureImage.ExportFilterIndex.

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);

signatureImage.ExportFilterIndex = 1;
Console.WriteLine($"Export Filter Index used by Signature Image: {signatureImage.ExportFilterIndex}");