Skip to main content

DxReportDesignerCallbacks.PreviewCustomizeMenuActions Property

Specifies the JavaScript function that handles the Web Report Designer’s PreviewCustomizeMenuActions client-side event.

Namespace: DevExpress.Blazor.Reporting

Assembly: DevExpress.Blazor.Reporting.v23.2.JSBasedControls.Common.dll

NuGet Package: DevExpress.Blazor.Reporting.JSBasedControls.Common

Declaration

[Parameter]
public string PreviewCustomizeMenuActions { get; set; }

Property Value

Type Description
String

The name of a JavaScript function used to handle the PreviewCustomizeMenuActions event.

Remarks

The PreviewCustomizeElements event allows you to customize the Report Designer Preview’s toolbar and menu. The Report Designer Preview is the Document Viewer control built into the End-User Report Designer.

The handler function receives two parameters - the first parameter is the client-side Document Viewer (the event sender) that exposes the dx property to access the client-side DevExpress objects. The second parameter is an object with the following properties and methods:

  • Actions
    A collection of Actions available in the Web Document Viewer’s toolbar and menu.

  • GetById
    A method that allows you to obtain the Action by its ID value.

The following code hides the Print action in the toolbar:

window.ReportingDesignerCustomization = {
    // Remove the Print action from the toolbar.
    onPreviewCustomizeMenuActions: function (s, e) {
        var printAction = e.GetById(s.dx.Reporting.Viewer.ActionId.PrintPage);
        var index = e.Actions.indexOf(printAction);
        e.Actions.splice(index, 1);
    }
}
See Also