DxReportDesignerCallbacks.ComponentAdded Property

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

Namespace: DevExpress.Blazor.Reporting

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

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

Declaration

C#

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

VB.NET

<Parameter>
Public Property ComponentAdded As String

Property Value

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

Remarks

The ComponentAdded event is raised when a report control is dropped from the toolbox to the report in the Report Designer.

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 properties and methods:

• Model
  The model of the component that has been added to a report.

• Parent
  The control on which the component has been dropped.

The following example changes the text and textAlignment properties of label controls added to the report:

reporting_DesignerCustomization.js

window.ReportingDesignerCustomization = {
    onComponentAdded: function (s, e) {
        var model = e.Model;
        if (model.controlType === "XRLabel") {
            model.text("Label");
            model.textAlignment("MiddleCenter")
        }
    }
}

_Host.cshtml

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

Designer.razor

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