ASPxClientDashboardItemWidgetEventArgs Class

Provides data for events related to client widgets used to visualize data in dashboard items.

Declaration

declare class ASPxClientDashboardItemWidgetEventArgs extends ASPxClientEventArgs

Remarks

See the following topic for more information: Access to Underlying Widgets in ASP.NET Web Forms.

Warning

A use of ASPxClientDashboard API reduces flexibility when you configure the control. The DashboardControl underlies the ASPxClientDashboard object. The control provides access to all client settings and allows you to implement complex scenarios. We recommend that you use the DashboardControl API to configure the Web Dashboard on the client. More information: Client-Side Functionality.

Inherited Members

constructor

Inheritance

ASPxClientEventArgs

ASPxClientDashboardItemWidgetEventArgs

Properties

ItemName Property

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

Declaration

ItemName: string

Property Value

Type	Description
string	A string value that is the component name of the dashboard item.

Remarks

Use the ASPxClientDashboardItemWidgetEventArgs.GetWidget property to access the widget corresponding to the current dashboard item.

Methods

GetWidget Method

Returns an underlying widget corresponding to the current dashboard item.

Declaration

GetWidget(): any

Returns

Type	Description
any	An underlying widget.

Remarks

See Component Configuration Syntax topic for information on how to work with the obtained widget.

Note

The getWidget property can return an array of widgets for some dashboard items:

• For the PieItem, getWidget returns an array of dxPieChart widgets.
• For the GaugeItem, getWidget returns an array of dxCircularGauge or dxLinearGauge widgets.