StiExportService Class

Namespace: Stimulsoft.Report.Export

Inheritance

Inherits from: StiService

Properties

Methods

Method Details

CloseProgress

CloseProgress(): void

Export

Export(report: StiReport, file: string): void

Exports a document to the stream.

Parameters

• report (StiReport) — A report which is to be exported.
• file (string) — A file for the export of a document.

Export(report: StiReport, file: string, guiMode: StiGuiMode): void

Exports a document to the stream.

Parameters

• report (StiReport) — A report which is to be exported.
• file (string) — A file for the export of a document.
• guiMode (StiGuiMode)

Export(report: StiReport, file: string, sendEMail: bool): void

Exports a document to the stream.

Parameters

• report (StiReport) — A report which is to be exported.
• file (string) — A file for the export of a document.
• sendEMail (bool) — A parameter indicating whether is exported report will be sended via e-mail.

Export(report: StiReport, file: string, sendEMail: bool, guiMode: StiGuiMode): void

Exports a document to the stream.

Parameters

• report (StiReport) — A report which is to be exported.
• file (string) — A file for the export of a document.
• sendEMail (bool) — A parameter indicating whether is exported report will be sended via e-mail.
• guiMode (StiGuiMode)

Export(report: StiReport): void

Exports a document to the stream with dialog of saving file.

Parameters

• report (StiReport) — A report which is to be exported.

ExportTo

ExportTo(report: StiReport, stream: Stream, settings: StiExportSettings): void

Exports a document to the stream without dialog of the saving file.

Parameters

• report (StiReport) — A report which is to be exported.
• stream (Stream) — A stream in which report will be exported.
• settings (StiExportSettings) — A settings for the report exporting.

GetFilter

GetFilter(): string

Returns a filter for files of the export format.

Returns string — String with filter.

GetFilters static

GetFilters(): string

Returns the filter of all available services which serves for saving, loading a document.

Returns string — A Filter.

GetOrderFileName static

GetOrderFileName(baseName: string, index: int, totalPagesCount: int, extension: string): string

Parameters

• baseName (string)
• index (int)
• totalPagesCount (int)
• extension (string)

Returns string

InvokeExporting

InvokeExporting(page: StiPage, pages: StiPagesCollection, currentPass: int, maximumPass: int): void

Parameters

• page (StiPage)
• pages (StiPagesCollection)
• currentPass (int)
• maximumPass (int)

InvokeExporting(value: int, maximum: int, currentPass: int, maximumPass: int): void

Parameters

• value (int)
• maximum (int)
• currentPass (int)
• maximumPass (int)

InvokeExporting(e: StiExportingEventArgs): void

Parameters

• e (StiExportingEventArgs)

OnExporting

OnExporting(e: StiExportingEventArgs): void

Parameters

• e (StiExportingEventArgs)

OpenFile

OpenFile(fileName: string): void

Parameters

• fileName (string)

ProcessFile

ProcessFile(sendEMail: bool, openAfterExport: bool, fileName: string, report: StiReport): void

Parameters

• sendEMail (bool)
• openAfterExport (bool)
• fileName (string)
• report (StiReport)

SendEMail

SendEMail(subject: string, body: string, filePath: string): void

Parameters

• subject (string)
• body (string)
• filePath (string)

SendEMail(recipient: string, subject: string, body: string, filePath: string): void

Parameters

• recipient (string)
• subject (string)
• body (string)
• filePath (string)

ShowProgress

ShowProgress(): void

Events