Skip to main content
A newer version of this page is available. .
All docs
V21.2

WebDocumentViewerClientSideEvents.OnExport Property

Gets or sets the JavaScript function that handles the OnExport event, which occurs before a request for document export is sent.

Namespace: DevExpress.XtraReports.Web

Assembly: DevExpress.XtraReports.v21.2.Web.WebForms.dll

NuGet Package: DevExpress.Web.Reporting

Declaration

[DefaultValue("")]
public string OnExport { get; set; }

Property Value

Type Default Description
String String.Empty

The name of a JavaScript function or entire JavaScript function code that runs when the OnExport event occurs.

Remarks

The OnExport event occurs before the Document Viewer sends a request to print the document or to get the exported document.

The Document Viewer request that gets the exported document and the request to print the document are GET requests. If your application uses token-based authentication, handle the OnExport event to pass a token to the server when these requests are executed.

The handler function receives two parameters - the first parameter is the client-side DocumentViewer 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): WebDocumentViewerClientSideEventsBuilder.OnExport.

See Also