Class ExportBase

The base class for all export filters.

Inheritance

System.Object

System.MarshalByRefObject

System.ComponentModel.Component

ExportBase

Biff8Export

CSVExport

DBFExport

HTMLExport

ODFExport

OOExportBase

XMLExport

Namespace: FastReport.Olap.Export

Assembly: FastReport.Olap.dll

Syntax

public class ExportBase : Component, IComponent, IDisposable

Properties

AllowOpenAfter

Allows or disables the OpenAfterExport feature.

Declaration

public bool AllowOpenAfter { get; set; }

Property Value

Type	Description
System.Boolean

Cube

Declaration

public Cube Cube { get; set; }

Property Value

Type	Description
Cube

FileFilter

File filter that can be used in the "Save file" dialog.

Declaration

public string FileFilter { get; }

Property Value

Type	Description
System.String

FileName

File name to export to.

Declaration

protected string FileName { get; }

Property Value

Type	Description
System.String

GeneratedFiles

Gets a list of files generated by this export.

Declaration

public List<string> GeneratedFiles { get; }

Property Value

Type	Description
System.Collections.Generic.List<System.String>

HasMultipleFiles

Gets a value indicating that the export may produce multiple output files.

Declaration

public bool HasMultipleFiles { get; set; }

Property Value

Type	Description
System.Boolean

OpenAfterExport

Open the document after export.

Declaration

public bool OpenAfterExport { get; set; }

Property Value

Type	Description
System.Boolean

ShowProgress

Gets or sets a value that determines whether to show progress window during export or not.

Declaration

public bool ShowProgress { get; set; }

Property Value

Type	Description
System.Boolean

Slice

Declaration

public Slice Slice { get; set; }

Property Value

Type	Description
Slice

Stream

Stream to export to.

Declaration

protected Stream Stream { get; }

Property Value

Type	Description
System.IO.Stream

Styles

Declaration

public GridStyles Styles { get; set; }

Property Value

Type	Description
GridStyles

Methods

ApplyDialog(BaseExportForm)

Declaration

protected virtual void ApplyDialog(BaseExportForm dialog)

Parameters

Type	Name	Description
BaseExportForm	dialog

CreateDialog()

Declaration

protected virtual BaseExportForm CreateDialog()

Returns

Type	Description
BaseExportForm

Export()

Exports the report to a file.

Declaration

public bool Export()

Returns

Type	Description
System.Boolean	true if report was succesfully exported.

Remarks

This method displays an export options dialog, then prompts a file name using standard "Open file" dialog. If both dialogs were closed by OK button, exports the report and returns true.

Export(Stream)

Declaration

public void Export(Stream stream)

Parameters

Type	Name	Description
System.IO.Stream	stream

Export(String)

Declaration

public void Export(string fileName)

Parameters

Type	Name	Description
System.String	fileName

Finish()

This method is called when the export is finished.

Declaration

protected virtual void Finish()

GetFileFilter()

Returns a file filter for a save dialog.

Declaration

protected virtual string GetFileFilter()

Returns

Type	Description
System.String	String that contains a file filter, for example: "Bitmap image (.bmp)|.bmp"

GetTitle(ExportTitle)

Declaration

protected string GetTitle(ExportTitle title)

Parameters

Type	Name	Description
ExportTitle	title

Returns

Type	Description
System.String

Run()

This method is called when the export is performed.

Declaration

protected virtual void Run()

ShowDialog()

Displays a dialog with export options.

Declaration

public virtual bool ShowDialog()

Returns

Type	Description
System.Boolean	true if dialog was closed with OK button.

Start()

This method is called when the export starts.

Declaration

protected virtual void Start()

Events

OnGetCubeColumns

Declaration

public event ExportGetCubeColumnsEventHandler OnGetCubeColumns

Event Type

Type	Description
ExportGetCubeColumnsEventHandler

OnGetCubeRowCount

Declaration

public event ExportGetCubeRowCountEventHandler OnGetCubeRowCount

Event Type

Type	Description
ExportGetCubeRowCountEventHandler

OnGetCubeRowIndex

Declaration

public event ExportGetCubeRowIndexEventHandler OnGetCubeRowIndex

Event Type

Type	Description
ExportGetCubeRowIndexEventHandler

OnGetTitle

Declaration

public event ExportGetTitleEventHandler OnGetTitle

Event Type

Type	Description
ExportGetTitleEventHandler