Class ImageExport
Represents the image export filter.
Implements
Inherited Members
Namespace: FastReport.Export.Image
Assembly: FastReport.Base.dll
Syntax
public class ImageExport : ExportBase, IFRSerializable
Constructors
ImageExport()
Initializes a new instance of the ImageExport class.
Declaration
public ImageExport()
Properties
ImageFormat
Gets or sets the image format.
Declaration
public ImageExportFormat ImageFormat { get; set; }
Property Value
Type | Description |
---|---|
ImageExportFormat |
JpegQuality
Gets or sets the jpg image quality.
Declaration
public int JpegQuality { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
Remarks
This property is used if ImageFormat is set to Jpeg. By default it is set to 100. Use lesser value to decrease the jpg file size.
MonochromeTiff
Gets or sets a value that determines whether the Tiff export must produce monochrome image.
Declaration
public bool MonochromeTiff { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Remarks
Monochrome tiff image is compressed using the compression method specified in the MonochromeTiffCompression property.
MonochromeTiffCompression
Gets or sets the compression method for a monochrome TIFF image.
Declaration
public EncoderValue MonochromeTiffCompression { get; set; }
Property Value
Type | Description |
---|---|
EncoderValue |
Remarks
This property is used only when exporting to TIFF image, and the MonochromeTiff property is set to true.
The valid values for this property are: EncoderValue.CompressionNone, EncoderValue.CompressionLZW, EncoderValue.CompressionRle, EncoderValue.CompressionCCITT3, EncoderValue.CompressionCCITT4. The default compression method is CCITT4.
MultiFrameTiff
Gets or sets the value determines whether to produce multi-frame tiff file.
Declaration
public bool MultiFrameTiff { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
PaddingNonSeparatePages
Sets padding in non separate pages
Declaration
public int PaddingNonSeparatePages { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
Resolution
Gets or sets image resolution, in dpi.
Declaration
public int Resolution { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
Remarks
By default this property is set to 96 dpi. Use bigger values (300-600 dpi) if you going to print the exported images.
ResolutionX
Gets or sets horizontal image resolution, in dpi.
Declaration
public int ResolutionX { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
Remarks
Separate horizontal and vertical resolution is used when exporting to TIFF. In other cases, use the Resolution property instead.
ResolutionY
Gets or sets vertical image resolution, in dpi.
Declaration
public int ResolutionY { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
Remarks
Separate horizontal and vertical resolution is used when exporting to TIFF. In other cases, use the Resolution property instead.
SaveStreams
Enable or disable saving streams in GeneratedStreams collection.
Declaration
public bool SaveStreams { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
SeparateFiles
Gets or sets a value that determines whether to generate separate image file for each exported page.
Declaration
public bool SeparateFiles { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Remarks
If this property is set to false, the export filter will produce one big image containing all exported pages. Be careful using this property with a big report because it may produce out of memory error. And also when using Memory Stream and the value is true, an exception will be thrown.
Methods
ExportBand(BandBase)
This method is called for each band on exported page.
Declaration
protected override void ExportBand(BandBase band)
Parameters
Type | Name | Description |
---|---|---|
BandBase | band | Band, dispose after method compite. |
Overrides
ExportPageBegin(ReportPage)
This method is called at the start of exports of each page.
Declaration
protected override void ExportPageBegin(ReportPage page)
Parameters
Type | Name | Description |
---|---|---|
ReportPage | page | Page for export may be empty in this method. |
Overrides
ExportPageEnd(ReportPage)
This method is called at the end of exports of each page.
Declaration
protected override void ExportPageEnd(ReportPage page)
Parameters
Type | Name | Description |
---|---|---|
ReportPage | page | Page for export may be empty in this method. |
Overrides
Finish()
This method is called when the export is finished.
Declaration
protected override void Finish()
Overrides
GetFileFilter()
Returns a file filter for a save dialog.
Declaration
protected override string GetFileFilter()
Returns
Type | Description |
---|---|
System.String | String that contains a file filter, for example: "Bitmap image (.bmp)|.bmp" |
Overrides
Serialize(FRWriter)
Serializes the object.
Declaration
public override void Serialize(FRWriter writer)
Parameters
Type | Name | Description |
---|---|---|
FRWriter | writer | Writer object. |
Overrides
Remarks
Do not call this method directly. You should override it if you are developing a new component for FastReport.
This method is called when the object needs to save the state. It may happen when:
- saving the report to the file or stream;
- saving the report to the designer's undo buffer;
- assigning the object to another object using the Assign(Base) or AssignAll methods;
- saving the object to the designer's clipboard;
- saving the object to the preview (when run a report).
Start()
This method is called when the export starts.
Declaration
protected override void Start()