ReportDesignerClientSideEventsBuilder.CustomizeFieldListActions(String) Method

Sets the name of the JavaScript function or the entire code that will handle the Web Report Designer‘s CustomizeFieldListActions client-side event.

Namespace: DevExpress.AspNetCore.Reporting.ReportDesigner

Assembly: DevExpress.AspNetCore.Reporting.v23.2.dll

NuGet Package: DevExpress.AspNetCore.Reporting

Declaration

C#

public ReportDesignerClientSideEventsBuilder CustomizeFieldListActions(
    string callback
)

VB.NET

Public Function CustomizeFieldListActions(
    callback As String
) As ReportDesignerClientSideEventsBuilder

Parameters

Name	Type	Description
callback	String	The name of a JavaScript function or the entire JavaScript function code used to handle the CustomizeFieldListActions event.

Returns

Type	Description
ReportDesignerClientSideEventsBuilder	A ReportDesignerClientSideEventsBuilder that can be used to further configure the Report Designer’s client-side events.

Remarks

The CustomizeFieldListActions event occurs for each item in the Field List panel.

When implementing a handling function, use the objects passed as parameters. The first parameter passes the event sender that is the ClientReportDesigner object. The second one is an object with the following structure:

• Item

  Specifies an item that is currently being processed.

• Actions

  The collection that contains the current item’s available actions.

The following code snippet demonstrates how to hide the Remove parameter action for a specific report parameter.

CSHTML

@{
    var designer = Html.DevExpress().ReportDesigner("reportDesigner1")
        .Height("1000px")
        .Bind(Model.Report)
        .ClientSideEvents(configure => { configure.CustomizeFieldListActions("customizeFieldListActions"); });
}
@designer

JavaScript

<script type="text/javascript" id="script"> 
    function customizeFieldListActions(s, e) {
      if (e.Item instanceof DevExpress.Reporting.Designer.Data.Parameter && e.Item.parameterName() === "parameter1") {
          var removeAction = e.Actions.filter(action => action.displayText() === "Remove parameter")[0];
          removeAction.visible = false;
      }
    }
</script>