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

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

Examples

In this example the 'FilterIndex' property is set to '4' - which indicates the 'Portable Network Graphics (PNG)'.

TXTextControl.Image myImage = new TXTextControl.Image();

myImage.Sizeable = false;
myImage.HorizontalScaling = 75;
myImage.VerticalScaling = 75;
myImage.ExportCompressionQuality = 100;
myImage.ExportFileName = "MyFileName.PNG";
myImage.ExportFilterIndex = 3;
myImage.ExportMaxResolution = 0;
myImage.FileName = "MySampleImage.png";
myImage.FilterIndex = 4; // Here, the 'FilterIndex' is set to 4 (->> 'PNG')

textControl1.Images.Add(myImage, -1);
Dim myImage As TXTextControl.Image = New TXTextControl.Image()

myImage.Sizeable = False
myImage.HorizontalScaling = 75
myImage.VerticalScaling = 75
myImage.ExportCompressionQuality = 100
myImage.ExportFileName = "MyFileName.PNG"
myImage.ExportFilterIndex = 3
myImage.ExportMaxResolution = 0
myImage.FileName = "MySampleImage.png"
myImage.FilterIndex = 4 ' Here, the 'FilterIndex' is set to 4 (->> 'PNG')

textControl1.Images.Add(myImage, -1)