Class ODFExport

Base class for any ODF exports.

Inheritance
System.Object
Base
ExportBase
ODFExport
ODSExport
ODTExport
Implements
Inherited Members
FastReport.Export.ExportBase.TabsIsExists
FastReport.Export.ExportBase.Export(FastReport.Report, System.Collections.Generic.List<FastReport.Preview.PreparedPages>)
FastReport.Export.ExportBase.GetOverlayPage(FastReport.ReportPage)
FastReport.Base.IsSelected
FastReport.Base.IsParentSelected
FastReport.Base.Delete()
FastReport.Base.OnBeforeInsert(System.Int32)
FastReport.Base.OnAfterInsert(FastReport.InsertFrom)
FastReport.Base.SelectionChanged()
FastReport.Base.GetContextMenu()
FastReport.Base.GetImageIndex()
Namespace: FastReport.Export.Odf
Assembly: FastReport.dll
Syntax
public class ODFExport : ExportBase, IDisposable, IFRSerializable

Constructors

ODFExport()

Initializes a new instance of the ODFExport class.

Declaration
public ODFExport()

Properties

Creator

Creator of the document

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

ExportLocale

Gets or sets a value indicating that locale export are enabled.

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

IsXOTD

Is XODT format

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

Locale

Gets or sets locale for all document.

Declaration
public CultureInfo Locale { get; set; }
Property Value
Type Description
System.Globalization.CultureInfo

OdfCompliance

Gets or sets ODF Compliance standard.

Declaration
public ODFExport.OdfStandard OdfCompliance { get; set; }
Property Value
Type Description
ODFExport.OdfStandard

PageBreaks

Switch of page breaks

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

ParagraphBased

Translate RichObject to report objects

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

TranslateRich

Translate RichObject to report objects

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

Wysiwyg

Wysiwyg mode, set for better results

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

Methods

Export_Body(MemoryStream, ZipArchive)

Document body collected as list of XML strings

Declaration
protected void Export_Body(MemoryStream file, ZipArchive zip)
Parameters
Type Name Description
System.IO.MemoryStream file
ZipArchive zip

Export_GeneratedStyles(Stream)

These styles collected by extended export

Declaration
protected void Export_GeneratedStyles(Stream file)
Parameters
Type Name Description
System.IO.Stream file

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

ExportBandExt(BandBase)

Actually document is a sequence of objects in bands

Declaration
protected void ExportBandExt(BandBase band)
Parameters
Type Name Description
BandBase band
Exceptions
Type Condition
System.Exception

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

ExportPageBeginExt(ReportPage)

Every new document page

Declaration
protected void ExportPageBeginExt(ReportPage page)
Parameters
Type Name Description
ReportPage page

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

ExportPageEndExt(ReportPage)

Page break comes here

Declaration
protected void ExportPageEndExt(ReportPage page)
Parameters
Type Name Description
ReportPage page

Finish()

This method is called when the export is finished.

Declaration
protected override void Finish()
Overrides

GetRunStyle(HtmlTextRenderer.Run, Color)

Hasging styles

Declaration
protected string GetRunStyle(HtmlTextRenderer.Run run, Color background)
Parameters
Type Name Description
HtmlTextRenderer.Run run
System.Drawing.Color background
Returns
Type Description
System.String

GetStyleName(String, String)

Hash of styles of dicument

Declaration
protected string GetStyleName(string style_descritopn, string ID)
Parameters
Type Name Description
System.String style_descritopn
System.String ID
Returns
Type Description
System.String

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).

ShowDialog()

Displays a dialog with export options.

Declaration
public override bool ShowDialog()
Returns
Type Description
System.Boolean

true if dialog was closed with OK button.
Overrides
FastReport.Export.ExportBase.ShowDialog()
Remarks

Before calling this method, set the report.

Start()

This method is called when the export starts.

Declaration
protected override void Start()
Overrides

Implements