Class CSVExport

Represents the CSV export filter.

Inheritance
System.Object
Base
ExportBase
CSVExport
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.Csv
Assembly: FastReport.dll
Syntax
public class CSVExport : ExportBase, IDisposable, IFRSerializable

Constructors

CSVExport()

Initializes a new instance of the CSVExport class.

Declaration
public CSVExport()

Properties

DataOnly

Gets or sets a value that determines whether to export the databand rows only.

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

Encoding

Gets or set the resulting file encoding.

Declaration
public Encoding Encoding { get; set; }
Property Value
Type Description
System.Text.Encoding

EscapeQuotes

Gets or sets a value that disable escaping quotation marks for text.

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

NoQuotes

Gets or sets a value that disable quotation marks for text.

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

Separator

Gets or set the separator character used in csv format.

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

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

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

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