Skip to main content

DashboardToolbarItem Class

An element, contained in the dashboard title or dashboard item caption, such as a command button.

Namespace: DevExpress.DashboardWin

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

NuGet Package: DevExpress.Win.Dashboard

#Declaration

public class DashboardToolbarItem :
    IDashboardToolbarItem,
    IDisposable

#Remarks

Elements of this type are command buttons located in the dashboard title or dashboard item caption. They are contained in the e.Items collection accessible in the following event handlers:

Component Event
DashboardViewer CustomizeDashboardTitle, CustomizeDashboardItemCaption
DashboardDesigner CustomizeDashboardTitle, CustomizeDashboardItemCaption

View Example: WinForms Dashboard - How to customize the dashboard title and dashboard item captions

To add a new command button to the dashboard title or dashboard item caption, handle the related event, create a new DashboardToolbarItem instance, specify its characteristics and insert it into the e.Items collection:

// Add a button to navigate to the company site.
DashboardToolbarItem infoLinkItem = new DashboardToolbarItem("",
    new Action<DashboardToolbarItemClickEventArgs>((args) => {
        System.Diagnostics.Process.Start("https://www.devexpress.com/");
    }));
infoLinkItem.SvgImage = svgImageCollection1["support"];
e.Items.Insert(0,infoLinkItem);

#Inheritance

Object
DashboardToolbarItem
See Also