Class HTMLExport

Represents the HTML export filter.

Inheritance

System.Object

Base

ExportBase

HTMLExport

Implements

IFRSerializable

Inherited Members

ExportBase.Zoom

ExportBase.FileFilter

ExportBase.PageRange

ExportBase.PageNumbers

ExportBase.CurPage

ExportBase.OpenAfterExport

ExportBase.AllowOpenAfter

ExportBase.ShowProgress

ExportBase.GeneratedFiles

ExportBase.HasMultipleFiles

ExportBase.ShiftNonExportable

ExportBase.SaveInitialDirectory

ExportBase.Stream

ExportBase.FileName

ExportBase.Pages

ExportBase.ExportBand(Base)

ExportBase.GetPage(Int32)

ExportBase.Assign(Base)

ExportBase.Export(Report, Stream)

ExportBase.Export(Report, String)

Base.Name

Base.Restrictions

Base.Flags

Base.Parent

Base.BaseName

Base.ClassName

Base.Report

Base.Page

Base.ChildObjects

Base.AllObjects

Base.ZOrder

Base.IsAncestor

Base.IsDesigning

Base.IsPrinting

Base.IsRunning

Base.OriginalComponent

Base.SetProp(Base, Base)

Base.FloatDiff(Single, Single)

Base.DeserializeSubItems(FRReader)

Base.ExtractDefaultMacros(String)

Base.Dispose(Boolean)

Base.SetFlags(Flags, Boolean)

Base.SetReport(Report)

Base.SetName(String)

Base.SetParent(Base)

Base.SetParentCore(Base)

Base.FindObject(String)

Base.CreateUniqueName()

Base.Clear()

Base.Deserialize(FRReader)

Base.BaseAssign(Base)

Base.AssignAll(Base)

Base.HasParent(Base)

Base.HasFlag(Flags)

Base.HasRestriction(Restrictions)

Base.InvokeEvent(String, Object)

Base.OnAfterLoad()

Base.GetExpressions()

Base.GetCustomScript()

Base.ExtractMacros()

Base.IsHaveToConvert(Object)

Base.GetConvertedObjects()

Base.ForEachAllConvectedObjects(Object)

Namespace: FastReport.Export.Html

Assembly: FastReport.OpenSource.dll

Syntax

public class HTMLExport : ExportBase, IFRSerializable

Constructors

HTMLExport()

Initializes a new instance of the HTMLExport class.

Declaration

public HTMLExport()

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

GeneratedStreams

Gets list of generated streams.

Declaration

public List<Stream> GeneratedStreams { get; }

Property Value

Type	Description
System.Collections.Generic.List<System.IO.Stream>

HeightUnits

Specifies the height units in HTML export

Declaration

public HtmlSizeUnits HeightUnits { get; set; }

Property Value

Type	Description
HtmlSizeUnits

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

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

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

ExportBase.ExportPageBegin(ReportPage)

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

ExportBase.ExportPageEnd(ReportPage)

Finish()

This method is called when the export is finished.

Declaration

protected override void Finish()

Overrides

ExportBase.Finish()

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

ExportBase.GetFileFilter()

Init_WebMode()

For internal use only.

Declaration

public void Init_WebMode()

OnCustomDraw(CustomDrawEventArgs)

Draw any custom controls.

Declaration

public void OnCustomDraw(CustomDrawEventArgs e)

Parameters

Type	Name	Description
CustomDrawEventArgs	e

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

ExportBase.Serialize(FRWriter)

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

ExportBase.Start()

Events

CustomDraw

Draw any custom controls

Declaration

public event EventHandler<CustomDrawEventArgs> CustomDraw

Event Type

Type	Description
System.EventHandler<CustomDrawEventArgs>

Implements

IFRSerializable