ASPxClientDashboard.ItemWidgetCreated Event

Allows you to access underlying UI/Data Visualization widgets.

Namespace: DevExpress.DashboardWeb.Scripts

Assembly: DevExpress.Dashboard.v18.2.Web.WebForms.Scripts.dll

Declaration

public event ASPxClientDashboardItemWidgetCreatedEventHandler ItemWidgetCreated
Public Event ItemWidgetCreated As ASPxClientDashboardItemWidgetCreatedEventHandler

Event Data

The ItemWidgetCreated event handler receives an argument of the ASPxClientDashboardItemWidgetEventArgs type. The following properties provide information specific to this event.

Property Description
ItemName Gets the component name of the dashboard item for which the event was raised.

Remarks

The Web Dashboard uses DevExtreme widgets to visualize data within dashboard items. The ItemWidgetCreated event allows you to access these widgets and customize their settings if necessary.

The ASPxClientDashboard exposes the following events that allow you to access these widgets and customize their settings.

Note that 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 ASPxClientDashboardItemWidgetEventArgs.ItemName event parameter returns the component name of the dashboard item whose widget may be customized. Use the ASPxClientDashboardItemWidgetEventArgs.GetWidget method to access the corresponding underlying widget.

The following table lists dashboard items whose underlying widgets may be accessed when handling the ItemWidgetCreated event.

Dashboard Item

Underlying Widget(s)

GridDashboardItem

dxDataGrid

ChartDashboardItem

ScatterChartDashboardItem

dxChart

PieDashboardItem

an array of dxPieChart widgets

GaugeDashboardItem

an array of dxCircularGauge or dxLinearGauge widgets

MapDashboardItem

dxVectorMap

PivotDashboardItem

dxPivotGrid

ComboBoxDashboardItem

dxSelectBox or dxTagBox

ListBoxDashboardItem

dxList

TreeViewDashboardItem

dxTreeList

Note

Note that the dxTreeView widget is used in v17.1 and earlier.

TreemapDashboardItem

dxTreeMap

RangeFilterDashboardItem

dxRangeSelector

CardDashboardItem

CardWidget

TextBoxDashboardItem

n/a See Note

ImageDashboardItem

n/a See Note

CustomDashboardItem

n/a See Note

Note

The content of the TextBoxDashboardItem and ImageDashboardItem are an HTML element wrapped to a jQuery object.

Note

The CustomDashboardItem is a custom widget you can customize directly.

See Also