Back to Devexpress

DashboardItemControlEventArgs.DashboardItemName Property

dashboard-devexpress-dot-dashboardwin-dot-dashboarditemcontroleventargs-8b16d730.md

latest6.9 KB
Original Source

DashboardItemControlEventArgs.DashboardItemName Property

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

Namespace : DevExpress.DashboardWin

Assembly : DevExpress.Dashboard.v25.2.Win.dll

NuGet Package : DevExpress.Win.Dashboard

Declaration

csharp
public string DashboardItemName { get; }
vb
Public ReadOnly Property DashboardItemName As String

Property Value

TypeDescription
String

A String that is the component name of the dashboard item.

|

The following code snippets (auto-collected from DevExpress Examples) contain references to the DashboardItemName property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

winforms-dashboard-access-api-of-underlying-controls/CS/Dashboard_ControlAccess/Form1.cs#L17

csharp
DashboardItemControlEventArgs e) {
if (e.DashboardItemName == "pivotDashboardItem1") {
    PivotGridControl pivotGridControl = e.PivotGridControl;

winforms-dashboard-custom-properties/CS/WinForms-Dashboard-Custom-Properties/Modules/GridFixedColumnModule.cs#L40

csharp
if(e.GridControl != null) {
    GridDashboardItem gridItem = designer.Dashboard.Items[e.DashboardItemName] as GridDashboardItem;
    gridItem.GridOptions.ColumnWidthMode = GridColumnWidthMode.AutoFitToContents;

how-to-display-the-total-value-above-each-pie-chart/CS/TotalsInChartsExample/Form1.cs#L18

csharp
private void Viewer_DashboardItemControlUpdated(object sender, DashboardItemControlEventArgs e) {
    if (e.DashboardItemName == "pieDashboardItem1") {
        var viewer = (DashboardViewer)sender;

winforms-dashboard-display-each-series-in-separate-pane-for-chart-items/CS/MultiPaneExtension/MultiPaneModule.cs#L94

csharp
{
    ChartDashboardItem chartItem = dashboardControl.Dashboard.Items[e.DashboardItemName] as ChartDashboardItem;
    if (chartItem == null || chartItem.Panes.Count>1) return;

win-designer-pivot-as-master-filter/CS/DesignerSample/Form1.cs#L27

csharp
void OnDashboardItemControlCreated(object sender, DashboardItemControlEventArgs e) {
    if(e.DashboardItemName == "pivotDashboardItem1") {
        e.PivotGridControl.MouseDown += OnPivotGridControlMouseDown;

winforms-dashboard-access-api-of-underlying-controls/VB/Dashboard_ControlAccess/Form1.vb#L18

vb
Private Sub dashboardViewer1_DashboardItemControlCreated(ByVal sender As Object, ByVal e As DashboardItemControlEventArgs) Handles dashboardViewer1.DashboardItemControlCreated
    If e.DashboardItemName = "pivotDashboardItem1" Then
        Dim pivotGridControl As PivotGridControl = e.PivotGridControl

winforms-dashboard-custom-properties/VB/WinForms-Dashboard-Custom-Properties/Modules/GridFixedColumnModule.vb#L40

vb
If e.GridControl IsNot Nothing Then
    Dim gridItem As GridDashboardItem = TryCast(designer.Dashboard.Items(e.DashboardItemName), GridDashboardItem)
    gridItem.GridOptions.ColumnWidthMode = GridColumnWidthMode.AutoFitToContents

how-to-display-the-total-value-above-each-pie-chart/VB/TotalsInChartsExample/Form1.vb#L18

vb
Private Sub Viewer_DashboardItemControlUpdated(ByVal sender As Object, ByVal e As DashboardItemControlEventArgs)
    If e.DashboardItemName = "pieDashboardItem1" Then
        Dim viewer = DirectCast(sender, DashboardViewer)

winforms-dashboard-display-each-series-in-separate-pane-for-chart-items/VB/MultiPaneExtension/MultiPaneModule.vb#L91

vb
Private Sub DashboardItemControlUpdated(ByVal sender As Object, ByVal e As DashboardItemControlEventArgs)
    Dim chartItem As ChartDashboardItem = TryCast(dashboardControl.Dashboard.Items(e.DashboardItemName), ChartDashboardItem)
    If chartItem Is Nothing OrElse chartItem.Panes.Count>1 Then

win-designer-pivot-as-master-filter/VB/DesignerSample/Form1.vb#L29

vb
Private Sub OnDashboardItemControlCreated(ByVal sender As Object, ByVal e As DashboardItemControlEventArgs) Handles dashboardDesigner1.DashboardItemControlCreated
    If e.DashboardItemName = "pivotDashboardItem1" Then
        AddHandler e.PivotGridControl.MouseDown, AddressOf OnPivotGridControlMouseDown

See Also

DashboardItemControlEventArgs Class

DashboardItemControlEventArgs Members

DevExpress.DashboardWin Namespace