DashboardViewerApiOptionBuilder.OnItemWidgetCreated(String) Method

Specifies the JavaScript function (or its name) executed when the client widget is created.

Namespace: DevExpress.DashboardAspNetCore

Assembly: DevExpress.Dashboard.v24.1.AspNetCore.dll

NuGet Package: DevExpress.AspNetCore.Dashboard

Declaration

C#

public DashboardViewerApiOptionBuilder OnItemWidgetCreated(
    string onItemWidgetCreated
)

VB.NET

Public Function OnItemWidgetCreated(
    onItemWidgetCreated As String
) As DashboardViewerApiOptionBuilder

Parameters

Name	Type	Description
onItemWidgetCreated	String	The JavaScript function (or its name) executed when the event is raised.

Returns

Type	Description
DashboardViewerApiOptionBuilder	A reference to this instance after the operation has completed.

Remarks

Note

The dashboard item is re-created when you maximize / restore the item. All events connected with dashboard item life cycle (such as ItemWidgetCreated, ItemWidgetUpdated, etc.) are fired again.

Note

The ItemWidgetCreated event is not fired for a custom dashboard item.

The following code shows how to handle the ItemWidgetCreated, ItemWidgetUpdated, and ItemWidgetUpdating events:

<div style="position: absolute; left: 0; top: 0; right: 0; bottom: 0;">
@(Html.DevExpress().Dashboard("dashboardControl1")
    .Width("100%")
    .Height("100%")
    .UseNeutralFilterMode(true)
    .Extensions(e => e.ViewerApi(v => v.OnItemWidgetCreated("function(args) { customizeWidgets(args); }")))
    .Extensions(e => e.ViewerApi(v => v.OnItemWidgetUpdated("function(args) { customizeWidgets(args); }")))
    .Extensions(e => e.ViewerApi(v => v.OnItemWidgetUpdating("function(args) { unsubscribeFromEvents(args); }")))
)
</div>