ReportDesignerClientSideEventsBuilder.CustomizeToolbox(String) Method

Specifies the JavaScript function that handles the Web Report Designer‘s CustomizeToolbox client-side event.

Namespace: DevExpress.AspNetCore.Reporting.ReportDesigner

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

Declaration

public ReportDesignerClientSideEventsBuilder CustomizeToolbox(
    string callback
)

Parameters

Name Type Description
callback String

The name of a JavaScript function or the JavaScript function code used to handle the CustomizeToolbox event.

Returns

Type Description
ReportDesignerClientSideEventsBuilder

A ReportDesignerClientSideEventsBuilder that can be used to further configure the Report Designer Client Side Events.

Remarks

Handle this event to customize the Web Report Designer’s Toolbox - hide the built-in toolbox items or add custom toolbox items.

The ControlsFactory event argument contains information about all controls available in the Toolbox.

The following client-side event handler function hides the Label control in the End User Designer Toolbox:

function onCustomizeToolbox(s, e) {
  var labelInfo = e.ControlsFactory.getControlInfo("XRLabel");
  labelInfo.isToolboxItem = false;
}

Use the ControlsFactory.registerControl method to register a custom control. Review the following help topic that explains how to add a custom control to the toolbox: Create and Register a Custom Control in the Report Designer Toolbox (ASP.NET Web Forms).

See Also