Replacing the standard progress window
The progress window is shown during the following actions:
- running a report
- printing
- exporting
You may turn off the progress by setting the FastReport.Utils.Config.ReportSettings.ShowProgress
property to false
. Besides that, you may replace the standard progress window with your own. To do this, use the following events of the FastReport.Utils.Config.ReportSettings
global class (see the "Configuring the FastReport environment" section):
Event | Description |
---|---|
StartProgress |
Occurs once before the operation. In this event, you have to create your own progress window and show it. |
Progress |
Occurs each time when current report page is handled. In this event, you have to show the progress state in your window. |
FinishProgress |
Occurs once after the operation. In this event, you have to destroy the progress window. |
The Progress
event takes e
parameter of ProgressEventArgs
type. It has the following properties:
Property | Description |
---|---|
string Message |
The message text. |
int Progress |
The index of current report page being handled. |
int Total |
The number of total pages in a report. This parameter may be 0 when preparing a report, because the number of total pages is unknown. |
In most cases, you need to display the text from the e.Message
property, in the Progress
event handler. Other parameters may be useful if you want to display a progress bar.