Description

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

Syntax

public int ExportFilterIndex { get; set; }

Public Property ExportFilterIndex As Integer

Members

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

Examples

The following example inserts and configures a named, accessible company logo by using Image.ExportFilterIndex.

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

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

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.ExportFilterIndex = 1
Console.WriteLine($"Export Filter Index used by Image: {image.ExportFilterIndex}")

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