BarSplitButtonItem Class

Represents a bar button item supporting the drop-down functionality.

Namespace: DevExpress.Xpf.Bars

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

NuGet Package: DevExpress.Wpf.Core

Declaration

C#

public class BarSplitButtonItem :
    BarButtonItem

VB.NET

Public Class BarSplitButtonItem
    Inherits BarButtonItem

Remarks

The BarSplitButtonItem supports the drop-down functionality, displaying a drop-down window when clicking the item link. The BarSplitButtonItem contains the main button, displaying the item’s content and glyph, and a Down Arrow button. Clicking the main button invokes the ItemClick events (BarItem.ItemClick and BarManager.ItemClick) and a command (BarItem.Command). Clicking the Down Arrow button invokes the drop-down control, specified by the BarSplitButtonItem.PopupControl property.

You can hide the Down Arrow button via the BarSplitButtonItem.ActAsDropDown property. In this instance, clicking the main button invokes the ItemClick events and the specified command. And in addition, the assigned drop-down control pops up.

BarSplitButtonItem can be used to implement a sub-menu in a RadialContextMenu.

Example

This example creates a BarSplitButtonItem (a button with drop-down). Click the button’s Down Arrow to display a popup window. To add a custom popup content, use the PopupControlContainer as the PopupControl. To add other bar items, use the PopupMenu.

In XAML

Window1.xaml

<dxb:BarContainerControl>
    <dxb:ToolBarControl UseWholeRow="True">
        <dxb:BarSplitButtonItem Name="btnFontColor" Content="FontColor" Glyph="{dx:DXImage Image=ChangeFontStyle_16x16.png}" ArrowAlignment="Bottom" ItemClick="btnFontColor_ItemClick">
            <dxb:BarSplitButtonItem.PopupControl>
                <dxb:PopupControlContainer>
                    <UserControl>
                        <dxe:ColorChooser/>
                    </UserControl>
                </dxb:PopupControlContainer>
            </dxb:BarSplitButtonItem.PopupControl>
        </dxb:BarSplitButtonItem>
    </dxb:ToolBarControl>
</dxb:BarContainerControl>

In Code-Behind

Window1.xaml.cs

private void btnFontColor_ItemClick(object sender, DevExpress.Xpf.Bars.ItemClickEventArgs e) {
    PopupControlContainer pcc = (e.Item as DevExpress.Xpf.Bars.BarSplitButtonItem).PopupControl as PopupControlContainer;
    Color color = ((pcc.Content as UserControl).Content as ColorChooser).Color;
    MessageBox.Show("Color is applied: " + color.ToString());
}

View Example

Related GitHub Examples

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

XAML

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

<dxb:BarButtonItem x:Name="biInsertPicture" Command="{Binding InsertPicture, Mode=OneTime, Source={StaticResource commands}}" />
<dxb:BarSplitButtonItem x:Name="biInsertChartColumnCommandGroup" ActAsDropDown="True" Command="{Binding InsertChartColumnCommandGroup, Mode=OneTime, Source={StaticResource commands}}">
    <dxr:GalleryDropDownPopupMenu>

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

<dxb:BarButtonItem x:Name="biInsertPicture" Command="{Binding InsertPicture, Mode=OneTime, Source={StaticResource commands}}" />
<dxb:BarSplitButtonItem x:Name="biInsertChartColumnCommandGroup" ActAsDropDown="True" Command="{Binding InsertChartColumnCommandGroup, Mode=OneTime, Source={StaticResource commands}}">
    <dxr:GalleryDropDownPopupMenu>

Reporting_wpf-end-user-report-designer-how-to-customize-the-ribbon-toolbar-t281615/CS/ReportDesignerClassicViewTemplate.xaml#L78

</dxb:BarEditItem>
<dxb:BarSplitButtonItem Glyph="{dx:DXImage Image=ChangeFontStyle_16x16.png}" ActAsDropDown="True">
    <dxb:BarSplitButtonItem.PopupControl>

Reporting_how-to-remove-standard-bar-items-and-add-custom-ones-to-the-documentviewer-toolbar-e2974/CS/WpfApplication1/MainWindow.xaml#L73

<dxb:BarButtonItem x:Name="biZoomIn" Content="{dxp:PrintingStringId StringId=IncreaseZoom}" Command="{Binding Model.ZoomInCommand, ElementName=documentViewer1, FallbackValue={StaticResource disabledCommand}}" Glyph="{dxp:PrintingResourceImage ResourceName=Images/BarItems/ZoomIn_16x16.png}" Hint="{dxp:PrintingStringId StringId=IncreaseZoom_Hint}" LargeGlyph="{dxp:PrintingResourceImage ResourceName=Images/BarItems/ZoomIn_32x32.png}"/>
<dxb:BarSplitButtonItem x:Name="biExportFile" Content="{dxp:PrintingStringId StringId=ExportFile}" Command="{Binding Model.ExportCommand, ElementName=documentViewer1, FallbackValue={StaticResource disabledCommand}}" Glyph="{dxp:PrintingResourceImage ResourceName=Images/BarItems/Export_16x16.png}" Hint="{dxp:PrintingStringId StringId=ExportFile_Hint}" LargeGlyph="{dxp:PrintingResourceImage ResourceName=Images/BarItems/Export_32x32.png}">
    <dxb:BarSplitButtonItem.PopupControl>

Reporting_how-to-show-a-ribbon-preview-window-for-link-e4407/CS/RibbonPrintPreviewDemo/MainWindow.xaml#L73

<dxb:BarButtonItem x:Name="biZoomIn" Content="{dxp:PrintingStringId StringId=IncreaseZoom}" Command="{Binding Model.ZoomInCommand, ElementName=viewer, FallbackValue={StaticResource disabledCommand}}" Glyph="{dxp:PrintingResourceImage ResourceName=Images/BarItems/ZoomIn_16x16.png}" Hint="{dxp:PrintingStringId StringId=IncreaseZoom_Hint}" LargeGlyph="{dxp:PrintingResourceImage ResourceName=Images/BarItems/ZoomIn_32x32.png}" />
<dxb:BarSplitButtonItem x:Name="biExportFile" Content="{dxp:PrintingStringId StringId=ExportFile}" Command="{Binding Model.ExportCommand, ElementName=viewer, FallbackValue={StaticResource disabledCommand}}" Glyph="{dxp:PrintingResourceImage ResourceName=Images/BarItems/Export_16x16.png}" Hint="{dxp:PrintingStringId StringId=ExportFile_Hint}" LargeGlyph="{dxp:PrintingResourceImage ResourceName=Images/BarItems/Export_32x32.png}">
    <dxb:BarSplitButtonItem.PopupControl>

Implements

IControllerAction

Inheritance

Object

DispatcherObject

DependencyObject

ContentElement

FrameworkContentElement

BarItem

BarButtonItem

BarSplitButtonItem

BarSplitCheckItem