BarButtonItem Class

Represents a bar button item.

Namespace: DevExpress.Xpf.Bars

Assembly: DevExpress.Xpf.Core.v19.1.dll

Declaration

C#

public class BarButtonItem :
    BarItem

VB.NET

Public Class BarButtonItem
    Inherits BarItem

Remarks

Use this item to add a regular button to bars and menus.

Clicking a button invokes the BarItem.ItemClick and BarManager.ItemClick events. In addition, if a command is assigned to the BarItem.Command property, it’s invoked as well.

The item’s functionality can also be invoked by pressing the shortcut specified by the BarItem.KeyGesture property.

Example

This example shows how to create bar button items (BarButtonItem objects) and add a link separator between them. The separator is created using the DevExpress.Wpf.Bars.BarItemLinkSeparator class.

The following image shows the result:

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-create-bar-button-items-and-add-a-separator-between-them-e1575.

Application.xaml.vb

Imports System
Imports System.Collections.Generic
Imports System.Configuration
Imports System.Data
Imports System.Linq
Imports System.Windows

Namespace BarItemLinkSeparatorEx
    ''' <summary>
    ''' Interaction logic for App.xaml
    ''' </summary>
    Partial Public Class App
        Inherits Application

        Private Sub OnAppStartup_UpdateThemeName(ByVal sender As Object, ByVal e As StartupEventArgs)

            DevExpress.Xpf.Core.ApplicationThemeHelper.UpdateApplicationThemeName()
        End Sub
    End Class
End Namespace

Window1.xaml

<Window xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" 
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" 
        xmlns:dxb="http://schemas.devexpress.com/winfx/2008/xaml/bars" 
        xmlns:dx="http://schemas.devexpress.com/winfx/2008/xaml/core" 
        x:Class="BarItemLinkSeparatorEx.Window1" 
        Title="Window1" Height="300" Width="300">
    <Grid>
        <Grid.RowDefinitions>
            <RowDefinition Height="Auto" />
            <RowDefinition Height="*"/>
        </Grid.RowDefinitions>

        <dxb:BarContainerControl Grid.Row="0">
            <dxb:ToolBarControl Caption="Main Toolbar"  BarItemHorizontalIndent="10">
                <dxb:BarButtonItem Content="Undo" Glyph="{dx:DXImage Image=Undo_16x16.png}" ItemClick="itemClick"/>
                <dxb:BarButtonItem Content="Redo" Glyph="{dx:DXImage Image=Redo_16x16.png}" ItemClick="itemClick"/>
                <dxb:BarItemLinkSeparator />
                <dxb:BarButtonItem Content="Copy" Glyph="{dx:DXImage Image=Copy_16x16.png}" ItemClick="itemClick"/>
                <dxb:BarButtonItem Content="Paste" Glyph="{dx:DXImage Image=Paste_16x16.png}" ItemClick="itemClick"/>

            </dxb:ToolBarControl>
        </dxb:BarContainerControl>

        <RichTextBox Grid.Row="1"/>


    </Grid>
</Window>

Application.xaml

<Application x:Class="BarItemLinkSeparatorEx.App" xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" StartupUri="Window1.xaml" Startup="OnAppStartup_UpdateThemeName">
    <Application.Resources>

    </Application.Resources>
</Application>

Window1.xaml.vb

Imports System
Imports System.Collections.Generic
Imports System.Linq
Imports System.Text
Imports System.Windows
Imports System.Windows.Controls
Imports System.Windows.Data
Imports System.Windows.Documents
Imports System.Windows.Input
Imports System.Windows.Media
Imports System.Windows.Media.Imaging
Imports System.Windows.Navigation
Imports System.Windows.Shapes

Namespace BarItemLinkSeparatorEx
    ''' <summary>
    ''' Interaction logic for Window1.xaml
    ''' </summary>
    Partial Public Class Window1
        Inherits Window

        Public Sub New()
            InitializeComponent()
        End Sub

        ' Respond to clicking the bar items
        Private Sub itemClick(ByVal sender As Object, ByVal e As DevExpress.Xpf.Bars.ItemClickEventArgs)
            MessageBox.Show("Item " & e.Item.Content & " has been clicked.")
        End Sub

    End Class
End Namespace

Window1.xaml.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Data;
using System.Windows.Documents;
using System.Windows.Input;
using System.Windows.Media;
using System.Windows.Media.Imaging;
using System.Windows.Navigation;
using System.Windows.Shapes;

namespace BarItemLinkSeparatorEx {
    /// <summary>
    /// Interaction logic for Window1.xaml
    /// </summary>
    public partial class Window1 : Window {
        public Window1() {
            InitializeComponent();
        }

        // Respond to clicking the bar items
        private void itemClick(object sender, DevExpress.Xpf.Bars.ItemClickEventArgs e) {
            MessageBox.Show("Item " + e.Item.Content + " has been clicked.");
        }

    }
}

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the BarButtonItem 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#

how-to-bind-a-spreadsheet-to-an-ms-sql-server-database-wpf-spreadsheet-t480591/CS/WpfSpreadsheet_BindToDataSource/MainWindow.xaml#L21

<dxb:BarManager.Items>
    <dxb:BarButtonItem x:Name="biFileNew" Command="{Binding FileNew, Mode=OneTime, Source={StaticResource commands}}" />
    <dxb:BarButtonItem x:Name="biFileOpen" Command="{Binding FileOpen, Mode=OneTime, Source={StaticResource commands}}" />

how-to-assign-custom-in-place-editors-to-worksheet-cells-wpf-spreadsheet-t385458/CS/WpfSpreadsheet_CustomCellEditors/MainWindow.xaml#L22

<dxb:BarManager.Items>
    <dxb:BarButtonItem x:Name="biFileNew" Command="{Binding FileNew, Mode=OneTime, Source={StaticResource commands}}" />
    <dxb:BarButtonItem x:Name="biFileOpen" Command="{Binding FileOpen, Mode=OneTime, Source={StaticResource commands}}" />

wpf-spreadsheet-how-to-bind-a-worksheet-to-a-generic-list-or-a-bindinglist-data-source-t484261/CS/DataBindingToListExample/MainWindow.xaml#L16

<dxb:BarManager.Items>
    <dxb:BarButtonItem x:Name="biFileNew" Command="{Binding FileNew, Mode=OneTime, Source={StaticResource commands}}"/>
    <dxb:BarButtonItem x:Name="biFileOpen" Command="{Binding FileOpen, Mode=OneTime, Source={StaticResource commands}}"/>

how-to-handle-the-hyperlink-click-event-to-invoke-the-custom-form-t488029/CS/DXRichEditHyperlinkHandling/MainWindow.xaml#L20

<dxb:BarManager.Items>
    <dxb:BarButtonItem x:Name="biFileNew" Command="{Binding FileNew, Mode=OneTime, Source={StaticResource commands}}" />
    <dxb:BarButtonItem x:Name="biFileOpen" Command="{Binding FileOpen, Mode=OneTime, Source={StaticResource commands}}" />

dxrichedit-for-wpf-table-api-how-to-create-a-multiplication-table-in-code-e3296/CS/MainWindow.xaml#L26

<dxb:BarManager.Items>
    <dxb:BarButtonItem Command="{Binding Path=FileNew, Mode=OneTime, Source={StaticResource commands}}" Name="biFileNew" />
    <dxb:BarButtonItem Command="{Binding Path=FileOpen, Mode=OneTime, Source={StaticResource commands}}" Name="biFileOpen" />

VB.NET

how-to-create-simple-bars-from-code-e3057/VB/CreateBarsFromCode/MainPage.xaml.vb#L41

'Create a few bar buttons and add this to the BarManager.Items collection
Dim barButtonItem1 As New BarButtonItem()
barButtonItem1.Name = "bt1"

Implements

IControllerAction

Inheritance

Show 11 items

Object

DispatcherObject

DependencyObject

ContentElement

FrameworkContentElement

BarItem

BarButtonItem

BarCheckItem

BarSplitButtonItem

BarSubItem

BarSplitCheckItem

Extension Methods

GetErrorOperationCommands(Position)

GetErrorOperationCommands(Int32)

GetErrorOperationCommands(Point)