Description

Gets or sets the format used, if an image is inserted. 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. The technical article Loading and Saving Images describes how images can be loaded and saved.

Syntax

public int FilterIndex { get; set; }

Public Property FilterIndex As Integer

Members

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 inserts and configures a named, accessible company logo by using Image.FilterIndex.

TXTextControl.Image image = new() { FileName = @"Images\company-logo.png", Name = "CompanyLogo" };
textControl.Images.Add(image, -1);

image.FilterIndex = 1;
Console.WriteLine($"Filter Index used by Image: {image.FilterIndex}");

textControl.Save("report-with-logo.docx", StreamType.WordprocessingML);

Dim image As New TXTextControl.Image() With { .FileName = "Images\company-logo.png", .Name = "CompanyLogo" }
textControl.Images.Add(image, -1)

image.FilterIndex = 1
Console.WriteLine($"Filter Index used by Image: {image.FilterIndex}")

textControl.Save("report-with-logo.docx", StreamType.WordprocessingML)