DxReportDesignerCallbacks.CustomizeToolbox Property

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

Namespace: DevExpress.Blazor.Reporting

Assembly: DevExpress.Blazor.Reporting.v24.1.JSBasedControls.Common.dll

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

Declaration

C#

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

VB.NET

<Parameter>
Public Property CustomizeToolbox As String

Property Value

Type	Description
String	The name of a JavaScript function used to handle the CustomizeToolbox event.

Remarks

The CustomizeToolbox event enables you to customize the Web Report Designer’s Toolbox.

The handler function receives two parameters: the first parameter is the client-side Report Designer (the event sender) and the second parameter is an object with the following property:

• ControlsFactory
  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:

reporting_DesignerCustomization.js

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

_Host.cshtml

<script src="~/js/reporting_DesignerCustomization.js"></script>

Designer.razor

<DxReportDesigner ReportName="SampleReport" Height="1000px" Width="100%">
    <DxReportDesignerCallbacks CustomizeToolbox="ReportingDesignerCustomization.onCustomizeToolbox" />
</DxReportDesigner>

To register a custom control, use the *ControlsFactory.registerControl method. This method accepts the following parameters: the control name and the object that stores information about a custom toolbox item.