TdxCustomDashboardControl.OnBrowserFileDownload Event

Allows you to modify the dashboard file download target or prevent users from downloading dashboard content.

Declaration

property OnBrowserFileDownload: TdxDashboardControlBrowserFileDownloadEvent read; write;

Remarks

Handle the OnBrowserFileDownload event to run custom code when dashboard content is downloaded. Change the download target, replace the built-in Save As dialog, or cancel the operation based on application-specific conditions.

Event Occurrence

The OnBrowserFileDownload event occurs every time a user attempts to export dashboard content using the Export To button within the Dashboard UI (in any available format).

If the OnBrowserFileDownload event is unhandled, a click on the Export button in the Export To dialog displays the standard Save As dialog.

Event Parameters

The following parameters are available within an OnBrowserFileDownload event handler:

ASender

Provides access to the TdxDashboardControl component that raised the OnBrowserFileDownload event.

AFileName

Specifies the full absolute or relative path to the dashboard download target.

You can assign a path to the target file to this parameter.

ACancelDownload

Specifies if the download operation is canceled.

Assign True to this parameter within an OnBrowserFileDownload event handler to prevent users from downloading dashboard content as a file or implement a custom dashboard download operation.

Refer to the TdxDashboardControlBrowserFileDownloadEvent procedural type description for information about parameters accessible in an OnBrowserFileDownload event handler.