TX Text Control .NET for Windows Forms

ImageExportFilterIndex Property

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

Description

Sets the format used for saving all images contained in the document. 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 the original format of each image is used. The original format can be obtained with the Image.FilterIndex property. For a single image the value of this property can be overwritten with the Image.ExportFilterIndex property. The technical article Loading and Saving Images describes how images can be loaded and saved.

Syntax

public int ImageExportFilterIndex { 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 configures how the current document is exported to WordprocessingML by using SaveSettings.ImageExportFilterIndex.

textControl.Text = "Quarterly results";
SaveSettings saveSettings = new();

saveSettings.ImageExportFilterIndex = 1;
Console.WriteLine($"Image Export Filter Index used by Save Settings: {saveSettings.ImageExportFilterIndex}");

textControl.Save("quarterly-results.docx", StreamType.WordprocessingML, saveSettings);