BarButtonItemLink Class

Represents a link to the BarButtonItem.

Assembly: DevExpress.XtraBars.v18.1.dll

Declaration

C#
VB.NET

public class BarButtonItemLink :
    BarBaseButtonItemLink

Public Class BarButtonItemLink
    Inherits BarBaseButtonItemLink

Remarks

The BarButtonItemLink is a visual representation of the BarButtonItem. The BarButtonItem can have several item links. Each of them is a BarButtonItemLink class instance. Numerous links are used to represent one item across different toolbars and menus.

You can customize both a link and an item. If you customize the BarButtonItem, all changes are applied to all its link. Note that link customization affects a BarButtonItemLink class instance only.

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

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.

C#
VB.NET

a-custom-toolbar-button-with-checked-and-dropdown-styles-e2266/CS/MyRibbonControl.cs#L22

protected override RibbonItemViewInfo CreateItemViewInfo(BaseRibbonViewInfo viewInfo, IRibbonItem item) {
    BarButtonItemLink link = item as BarButtonItemLink;
    if(link != null && link.Item is BarCheckAndDropDownButton)

how-to-create-a-table-bar-item-for-ribboncontrol-e4491/CS/testSample/TableBarItem/CustomController/MyBarAndDockingController.cs#L34

{
    PaintStyles[i].ItemInfoCollection.Add(new BarItemInfo("TableBarItem", "Table", 0, typeof(TableBarItem), typeof(BarButtonItemLink), typeof(BarButtonLinkViewInfo), PaintStyles[i].CreateButtonItemLinkPainter(), true, true));
}

how-to-handle-the-click-on-the-drop-down-arrow-for-the-barbuttonitem-e2167/CS/WindowsApplication3/MyBarButtonItemLink.cs#L16

{
    public class MyBarButtonItemLink : BarButtonItemLink
    {

dashboard-designer-how-to-import-shape-files-into-map-items-using-openfiledialog-t567206/CS/T566254/Form1.cs#L65


if (e.Menu.ItemLinks.OfType<BarButtonItemLink>().Where(i => i.Item.Name == "mapCustomShapeFile").Count() == 0) {
    var mapDefaultShapefile = e.Menu.ItemLinks.FirstOrDefault(l => l.Item is MapFullExtentBarItem);

a-custom-toolbar-button-with-checked-and-dropdown-styles-e2266/VB/MyRibbonControl.vb#L27

Protected Overrides Function CreateItemViewInfo(ByVal viewInfo As BaseRibbonViewInfo, ByVal item As IRibbonItem) As RibbonItemViewInfo
    Dim link As BarButtonItemLink = TryCast(item, BarButtonItemLink)
    If link IsNot Nothing AndAlso TypeOf link.Item Is BarCheckAndDropDownButton Then

how-to-create-a-table-bar-item-for-ribboncontrol-e4491/VB/testSample/TableBarItem/CustomController/MyBarAndDockingController.vb#L30

For i As Integer = 0 To PaintStyles.Count - 1
    PaintStyles(i).ItemInfoCollection.Add(New BarItemInfo("TableBarItem", "Table", 0, GetType(TableBarItem), GetType(BarButtonItemLink), GetType(BarButtonLinkViewInfo), PaintStyles(i).CreateButtonItemLinkPainter(), True, True))
Next i

how-to-handle-the-click-on-the-drop-down-arrow-for-the-barbuttonitem-e2167/VB/WindowsApplication3/MyBarButtonItemLink.vb#L17

Public Class MyBarButtonItemLink
    Inherits BarButtonItemLink
    Public Sub New(ByVal ALinks As BarItemLinkReadOnlyCollection, ByVal AItem As BarItem, ByVal ALinkedObject As Object)

dashboard-designer-how-to-import-shape-files-into-map-items-using-openfiledialog-t567206/VB/T566254/Form1.vb#L74


If e.Menu.ItemLinks.OfType(Of BarButtonItemLink)().Where(Function(i) i.Item.Name = "mapCustomShapeFile").Count() = 0 Then
    Dim mapDefaultShapefile = e.Menu.ItemLinks.FirstOrDefault(Function(l) TypeOf l.Item Is MapFullExtentBarItem)