ReportDesignerClientSideEvents.PreviewOnExport Property
Specifies the JavaScript function that handles the PreviewOnExport event, which occurs before a request for document export is sent.
Namespace: DevExpress.XtraReports.Web
Assembly: DevExpress.XtraReports.v24.1.Web.WebForms.dll
NuGet Package: DevExpress.Web.Reporting
Declaration
Property Value
| Type | Default | Description |
|---|---|---|
| String | String.Empty | The name of a JavaScript function or entire JavaScript function code that runs when the PreviewOnExport event occurs. |
Remarks
The PreviewOnExport event occurs before the Report Designer Preview sends a request to print the document or to get the exported document.
Note
In v23.1 and higher, our Web Reporting Controls use the Fetch API for all request types. In earlier versions, the Web Reporting Controls used jQuery Ajax to send web requests, and form.submit for export and print operations. The use of the Fetch API includes a unified method to pass request headers from a client to a back-end server. This eliminates the need to handle the PreviewOnExport event to process custom request headers for export and print operations.
The handler function receives two parameters - the first parameter is the client-side Preview object, the second parameter is the object with the following properties:
- RequestUrl
- A string that specifies the request URL.
- FormData
- A set of key-value pairs.
Refer to the following topic for an example of use (an Angular client and ASP.NET Core server-side application): ReportDesignerPreviewClientSideEventsBuilder.OnExport.