FilterIndex Property
- Namespace
TXTextControl
- Package
TXTextControl.asTextControl. Core. SDK TXTextControl.from the private NuGet feed or Text Control Offline PackagesCore. dll
- Also in
TXTextControl.asTextControl. ASP. SDK TXTextControl.dll
Description
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.
Syntax
public int FilterIndex { get; set; }Public Property FilterIndex As IntegerMembers
| Value | Description |
|---|---|
| 1 | Windows Bitmap (.BMP) |
| 2 | Tagged Image Format (.TIF) |
| 3 | Windows Metafile (.WMF) |
| 4 | Portable Network Graphics (.PNG) |
| 5 | JPEG File Interchange Format (.JPG, .JPEG) |
| 6 | Graphics Interchange Format (.GIF) |
| 7 | Windows Enhanced Metafile (.EMF) |
| 8 | Scalable Vector Graphics (.SVG) |
Examples
The following example adds a visible handwritten-signature image to an approval field by using SignatureImage.FilterIndex.
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.FilterIndex = 1;
Console.WriteLine($"Filter Index used by Signature Image: {signatureImage.FilterIndex}");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)
signatureImage.FilterIndex = 1
Console.WriteLine($"Filter Index used by Signature Image: {signatureImage.FilterIndex}")