Class HTMLExport

Represents the HTML export filter.

Inheritance
System.Object
Base
ExportBase
HTMLExport
Implements
Inherited Members
Namespace: FastReport.Export.Html
Assembly: FastReport.Base.dll
Syntax
public class HTMLExport : ExportBase, IDisposable, IFRSerializable, IHTMLBaseExport

Constructors

HTMLExport()

Initializes a new instance of the HTMLExport class.

Declaration
public HTMLExport()

HTMLExport(Boolean)

Initializes a new instance of the HTMLExport class for WebPreview mode.

Declaration
public HTMLExport(bool webPreview)
Parameters
Type Name Description
System.Boolean webPreview

Properties

Count

For internal use only.

Declaration
public int Count { get; }
Property Value
Type Description
System.Int32

EmbeddedImages

Gets or sets images, embedded in html (hash:base64Image)

Declaration
public Dictionary<string, string> EmbeddedImages { get; set; }
Property Value
Type Description
System.Collections.Generic.Dictionary<System.String, System.String>

EmbedPictures

Enable or disable embedding pictures in HTML export

Declaration
public bool EmbedPictures { get; set; }
Property Value
Type Description
System.Boolean

EnableMargins

Enable or disable margins for pages. Works only for Layers-mode.

Declaration
public bool EnableMargins { get; set; }
Property Value
Type Description
System.Boolean

EnableVectorObjects

Enable or disable export of vector objects such as Barcodes in SVG format.

Declaration
public bool EnableVectorObjects { get; set; }
Property Value
Type Description
System.Boolean

ExportMode

Gets or sets html export mode

Declaration
public HTMLExport.ExportType ExportMode { get; set; }
Property Value
Type Description
HTMLExport.ExportType

Format

Specifies the output format

Declaration
public HTMLExportFormat Format { get; set; }
Property Value
Type Description
HTMLExportFormat

HeightUnits

Specifies the height units in HTML export

Declaration
public HtmlSizeUnits HeightUnits { get; set; }
Property Value
Type Description
HtmlSizeUnits

HighQualitySVG

Enable or disable a picture optimization.

Declaration
public bool HighQualitySVG { get; set; }
Property Value
Type Description
System.Boolean

ImageFormat

Gets or sets the image format.

Declaration
public ImageFormat ImageFormat { get; set; }
Property Value
Type Description
ImageFormat

Layers

Enable or disable layers export mode

Declaration
public bool Layers { get; set; }
Property Value
Type Description
System.Boolean

Navigator

Enable or disable the page navigator in html export

Declaration
public bool Navigator { get; set; }
Property Value
Type Description
System.Boolean

NotRotateLandscapePage

Not rotate landscape page when print.

Declaration
public bool NotRotateLandscapePage { get; set; }
Property Value
Type Description
System.Boolean

OnClickTemplate

Sets an onclick template

Declaration
public string OnClickTemplate { get; set; }
Property Value
Type Description
System.String

PageBreaks

Enable or disable the breaks between pages in print preview when single page mode is enabled

Declaration
public bool PageBreaks { get; set; }
Property Value
Type Description
System.Boolean

Pictures

Enable or disable the pictures in HTML export

Declaration
public bool Pictures { get; set; }
Property Value
Type Description
System.Boolean

PreparedPages

For internal use only.

Declaration
public List<HTMLPageData> PreparedPages { get; }
Property Value
Type Description
System.Collections.Generic.List<HTMLPageData>

Preview

Enable or disable preview in Web settings

Declaration
public bool Preview { get; set; }
Property Value
Type Description
System.Boolean

Print

Enable or disable showing of print dialog in browser when html document is opened

Declaration
public bool Print { get; set; }
Property Value
Type Description
System.Boolean

PrintPageData

Gets print page data

Declaration
public HTMLPageData PrintPageData { get; }
Property Value
Type Description
HTMLPageData

ReportID

Sets a ID of report

Declaration
public string ReportID { get; set; }
Property Value
Type Description
System.String

SaveStreams

Enable or disable saving streams in GeneratedStreams collection.

Declaration
public bool SaveStreams { get; set; }
Property Value
Type Description
System.Boolean

SinglePage

Enable or disable the single HTML page creation

Declaration
public bool SinglePage { get; set; }
Property Value
Type Description
System.Boolean

StylePrefix

For internal use only.

Declaration
public string StylePrefix { get; set; }
Property Value
Type Description
System.String

SubFolder

Enable or disable the sub-folder for files of export

Declaration
public bool SubFolder { get; set; }
Property Value
Type Description
System.Boolean

WebImagePrefix

For internal use only.

Declaration
public string WebImagePrefix { get; set; }
Property Value
Type Description
System.String

WebImageSuffix

For internal use only.

Declaration
public string WebImageSuffix { get; set; }
Property Value
Type Description
System.String

WidthUnits

Specifies the width units in HTML export

Declaration
public HtmlSizeUnits WidthUnits { get; set; }
Property Value
Type Description
HtmlSizeUnits

Wysiwyg

Gets or sets the WYSIWYG quality of export

Declaration
public bool Wysiwyg { get; set; }
Property Value
Type Description
System.Boolean

Methods

Dispose(Boolean)

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing
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

ExportReportObject(ReportComponentBase)

For developers only

Declaration
public void ExportReportObject(ReportComponentBase obj)
Parameters
Type Name Description
ReportComponentBase obj

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

Init_WebMode()

For internal use only.

Declaration
public void Init_WebMode()

ProcessPageBegin(Int32, Int32, ReportPage)

Process Page with number p and real page ReportPage

Declaration
public void ProcessPageBegin(int p, int ReportPage, ReportPage page)
Parameters
Type Name Description
System.Int32 p
System.Int32 ReportPage
ReportPage page

ProcessPageEnd(Int32, Int32)

Process Page with number p and real page ReportPage

Declaration
public void ProcessPageEnd(int p, int ReportPage)
Parameters
Type Name Description
System.Int32 p
System.Int32 ReportPage

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()
Overrides

Events

CustomDraw

Draw any custom controls

Declaration
public event EventHandler<CustomDrawEventArgs> CustomDraw
Event Type
Type Description
System.EventHandler<CustomDrawEventArgs>

Implements