ASPxClientDashboard.ItemWidgetUpdated Event

Allows you to access underlying UI/Data Visualization widgets.

Namespace: DevExpress.DashboardWeb.Scripts

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

Declaration

C#

public event ASPxClientDashboardItemWidgetUpdatedEventHandler ItemWidgetUpdated

VB.NET

Public Event ItemWidgetUpdated As ASPxClientDashboardItemWidgetUpdatedEventHandler

Event Data

The ItemWidgetUpdated event's data class is ASPxClientDashboardItemWidgetEventArgs. 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.

The event data class exposes the following methods:

Method	Description
GetWidget()	Returns an underlying widget corresponding to the current dashboard item.

Remarks

The Web Dashboard uses DevExtreme widgets to visualize data within dashboard items. The ItemWidgetUpdated 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.

• The ASPxClientDashboard.ItemWidgetCreated event is raised once for each widget when the dashboard is loaded to client. Handle this event to subscribe to events of the client widget.
• ASPxClientDashboard.ItemWidgetUpdating/ItemWidgetUpdated events are raised when the client widget needs to be updated. For instance, this can be related to applying master filtering or changing parameter values. Handle the ASPxClientDashboard.ItemWidgetUpdating event to unsubscribe from events of the client widget. To customize the widget according your requirements, handle the ItemWidgetUpdated event. This allows you to prevent the ASPxClientDashboard from rewriting customized options.

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 ItemWidgetUpdated 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 ItemWidgetUpdated 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.