Table of Contents

Class ExportBase

Namespace: FastReport.Olap.Export
Assembly: FastCube.Core.dll

The base class for all export filters.

public class ExportBase : Component

Inheritance

objectMarshalByRefObjectComponentExportBase

Derived

Biff8Export, CSVExport, DBFExport, HTMLExport, ODFExport, OOExportBase, XMLExport

Properties

AllowOpenAfter

Allows or disables the OpenAfterExport feature.

public bool AllowOpenAfter { get; set; }

Property Value

bool

Cube

Gets or sets the cube.

public Cube Cube { get; set; }

Property Value

Cube

FileFilter

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

public string FileFilter { get; }

Property Value

string

FileName

File name to export to.

protected string FileName { get; }

Property Value

string

GeneratedFiles

Gets a list of files generated by this export.

public List<string> GeneratedFiles { get; }

Property Value

List<string>

HasMultipleFiles

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

public bool HasMultipleFiles { get; set; }

Property Value

bool

OpenAfterExport

Open the document after export.

public bool OpenAfterExport { get; set; }

Property Value

bool

ShowProgress

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

public bool ShowProgress { get; set; }

Property Value

bool

Slice

Gets or sets the slice.

public Slice Slice { get; set; }

Property Value

Slice

Stream

Stream to export to.

protected Stream Stream { get; }

Property Value

Stream

Styles

Gets or sets Styles.

public GridStyles Styles { get; set; }

Property Value

GridStyles

Methods

Export(string)

Exports to the file by file name.

public void Export(string fileName)

Parameters

fileName string

Export(Stream)

Exports to the stream.

public void Export(Stream stream)

Parameters

stream Stream

Export()

Exports the report to a file.

public bool Export()

Returns

bool

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.

Finish()

This method is called when the export is finished.

protected virtual void Finish()

GetFileFilter()

Returns a file filter for a save dialog.

protected virtual string GetFileFilter()

Returns

string

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

GetTitle(ExportTitle)

Gets the title from export title.

protected string GetTitle(ExportTitle title)

Parameters

title ExportTitle

Returns

string

RegisterExportDialog(Type, Type)

Register an export dialog.

public static void RegisterExportDialog(Type exportBaseType, Type exportDialogType)

Parameters

exportBaseType Type

Type of export.

exportDialogType Type

Type of dialog.

Run()

This method is called when the export is performed.

protected virtual void Run()

ShowDialog()

Displays a dialog with export options.

public virtual bool ShowDialog()

Returns

bool

true if dialog was closed with OK button.

Start()

This method is called when the export starts.

protected virtual void Start()

OnGetCubeColumns

Event on getting cube columns.

public event ExportGetCubeColumnsEventHandler OnGetCubeColumns

Event Type

ExportGetCubeColumnsEventHandler

OnGetCubeRowCount

Event on getting number of cube rows.

public event ExportGetCubeRowCountEventHandler OnGetCubeRowCount

Event Type

ExportGetCubeRowCountEventHandler

OnGetCubeRowIndex

Event on getting index of cube row.

public event ExportGetCubeRowIndexEventHandler OnGetCubeRowIndex

Event Type

ExportGetCubeRowIndexEventHandler

OnGetTitle

Event on getting title.

public event ExportGetTitleEventHandler OnGetTitle

Event Type

ExportGetTitleEventHandler