Skip to main content

DxReportDesignerCallbacks.CustomizeMenuActions Property

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

Namespace: DevExpress.Blazor.Reporting

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

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

Declaration

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

Property Value

Type Description
String

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

Remarks

The CustomizeMenuActions event enables you to customize the Web Report Designer toolbar and menu.

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 toolbar and menu.

  • GetById
    A method that allows you to obtain the Action by its ActionId value. Use the s.dx notation to access the ActionId enumeration.

window.ReportingDesignerCustomization = {
    onCustomizeMenuActions: function (s, e) {
        //Move the Save button to the toolbar.
        var saveAction = e.GetById(s.dx.Reporting.Designer.Actions.ActionId.Save); 
        saveAction.container = "toolbar";

        //Add the Custom New Report action
        var newReportAction = e.GetById(s.dx.Reporting.Designer.Actions.ActionId.NewReport); 
        if(newReportAction) {
            newReportAction.clickAction = function(report) {
                s.OpenReport("CustomNewReport");
            }

            //Move the New button to the toolbar
            newReportAction.container = "toolbar";
        }
    }
}
See Also