WebDocumentViewerClientSideEventsBuilder Class

Enables you to specify handlers for the Web Document Viewer‘s client-side events.

Namespace: DevExpress.AspNetCore.Reporting.WebDocumentViewer

Assembly: DevExpress.AspNetCore.Reporting.v24.1.dll

NuGet Package: DevExpress.AspNetCore.Reporting

Declaration

C#

public class WebDocumentViewerClientSideEventsBuilder :
    WebDocumentViewerClientSideEventsBuilderBase<WebDocumentViewerClientSideEventsBuilder, WebDocumentViewerClientSideEvents>

VB.NET

Public Class WebDocumentViewerClientSideEventsBuilder
    Inherits WebDocumentViewerClientSideEventsBuilderBase(Of WebDocumentViewerClientSideEventsBuilder, WebDocumentViewerClientSideEvents)

Related API Members

The following members return WebDocumentViewerClientSideEventsBuilder objects:

• WebDocumentViewerClientSideEventsBuilder.CustomizeElements(String)
• WebDocumentViewerClientSideEventsBuilder.CustomizeExportOptions(String)
• WebDocumentViewerClientSideEventsBuilder.CustomizeMenuActions(String)
• WebDocumentViewerClientSideEventsBuilder.DocumentReady(String)
• WebDocumentViewerClientSideEventsBuilder.EditingFieldChanged(String)
• WebDocumentViewerClientSideEventsBuilder.OnExport(String)
• WebDocumentViewerClientSideEventsBuilder.ParametersSubmitted(String)
• WebDocumentViewerClientSideEventsBuilder.PreviewClick(String)

Remarks

The WebDocumentViewerClientSideEventsBuilder class exposes methods whose names resemble client-side events of the Web Document Viewer. You can pass handlers for the events via the methods’ parameter. To access a WebDocumentViewerClientSideEventsBuilder object, use the ClientSideEvents(Action<WebDocumentViewerClientSideEventsBuilder>) method of the WebDocumentViewerBuilder object.

The code below demonstrates how to handle the Web Document Viewer’s CustomizeMenuActions client-side event in an ASP.NET Core application.

CSHTML

@{
    var documentViewer = Html.DevExpress().WebDocumentViewer("webDocumentViewer1")
        .Height("1000px")
        .Bind(Model.Report)
        .ClientSideEvents(configure => { configure.CustomizeMenuActions("customizeMenuActions"); });;
}
@documentViewer

JavaScript

<script type="text/javascript" id="script">
    function customizeMenuActions(s, e) {
        // Get the "Export" action and hide it.
        var exportAction = e.GetById(DevExpress.Reporting.Viewer.ActionId.ExportTo);
        if (exportAction)
            exportAction.visible = false;
    }
</script>

Inheritance

Object

WebDocumentViewerClientSideEventsBuilderBase<WebDocumentViewerClientSideEventsBuilder, DevExpress.AspNetCore.Reporting.WebDocumentViewer.Native.DataContracts.WebDocumentViewerClientSideEvents>

WebDocumentViewerClientSideEventsBuilder