RibbonGalleryBarItem Class

A bar item that displays a gallery.

Assembly: DevExpress.Xpf.Ribbon.v19.2.dll

Declaration

C#
VB.NET

public class RibbonGalleryBarItem :
    BarItem,
    ILinksHolder,
    IMultipleElementRegistratorSupport,
    IBarNameScopeSupport,
    IInputElement,
    ILogicalChildrenContainer

Public Class RibbonGalleryBarItem
    Inherits BarItem
    Implements ILinksHolder,
               IMultipleElementRegistratorSupport,
               IBarNameScopeSupport,
               IInputElement,
               ILogicalChildrenContainer

Remarks

Use RibbonGalleryBarItem objects to add galleries to the RibbonControl.

BarItemTypes-RibbonGalleryBarItem

To specify a gallery for the RibbonGalleryBarItem, use the RibbonGalleryBarItem.Gallery property. A gallery consists of gallery groups (GalleryItemGroup), each of which can display any number of gallery items (GalleryItem).

Optionally, you can implement an extended version of the created gallery that will be displayed as a popup window when the RibbonGalleryBarItem‘s Dropdown button is clicked. A dropdown gallery can be specified via the RibbonGalleryBarItem.DropDownGallery property.

By default, captions (GalleryItemGroup.Caption) of gallery groups are not visible for in-ribbon galleries. By default, the captions are visible for dropdown galleries.

Note

RibbonGalleryBarItem items are only supported within a RibbonPageGroup.

Example

This example shows how to create an in-Ribbon gallery, represented by the RibbonGalleryBarItem class. The gallery’s items are created in code (see the complete sample).

RibbonControl_Ex_CustomCategory

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-create-a-ribboncontrol-e2201.

MainWindow.xaml

<dxr:RibbonPageCategory x:Name="categorySelection" 
                            Caption="Selection" 
                            Color="Yellow" 
                            IsVisible="False">
    <dxr:RibbonPage Caption="Gallery Page">
        <dxr:RibbonPageGroup Caption="Font" ShowCaptionButton="False">
            <!--region #RibbonGalleryBarItem-->
            <dxr:RibbonGalleryBarItem Name="gFont" Glyph="{dxc:DXImage Image=ChangeFontStyle_16x16.png}" Content="Font">
                <dxr:RibbonGalleryBarItem.Links>
                    <dxb:BarEditItemLink BarItemName="eFontSize" RibbonStyle="SmallWithText"/>
                </dxr:RibbonGalleryBarItem.Links>
                <dxr:RibbonGalleryBarItem.Gallery>
                    <dxb:Gallery MinColCount="1" ColCount="5" 
                     ItemCheckMode="Single" 
                     IsGroupCaptionVisible="False" 
                     IsItemCaptionVisible="False"
                     IsItemDescriptionVisible="False" 
                     ItemChecked="FontFamilyGallery_ItemChecked" 
                     ItemCaptionVerticalAlignment="Center">
                        <dxb:Gallery.Groups>
                            <dxb:GalleryItemGroup Name="FontFamilyGalleryGroup" />
                        </dxb:Gallery.Groups>
                    </dxb:Gallery>
                </dxr:RibbonGalleryBarItem.Gallery>

                <dxr:RibbonGalleryBarItem.DropDownGallery>
                    <dxb:Gallery MinColCount="1" ColCount="1" 
                     RowCount="5" 
                     ItemCheckMode="Single" 
                     IsGroupCaptionVisible="False"
                     AllowFilter="False"
                     IsItemGlyphVisible="True" 
                     IsItemDescriptionVisible="False" 
                     ItemContentHorizontalAlignment="Stretch"
                     ItemContentVerticalAlignment="Center" 
                     ItemChecked="FontFamilyGallery_ItemChecked"
                     SizeMode="Vertical">
                        <dxb:Gallery.Groups>
                            <dxb:GalleryItemGroup Name="FontFamilyDropDownGalleryGroup" />
                        </dxb:Gallery.Groups>
                    </dxb:Gallery>
                </dxr:RibbonGalleryBarItem.DropDownGallery>
            </dxr:RibbonGalleryBarItem>
            <!--endregion #RibbonGalleryBarItem-->

            <dxb:BarEditItem Name="eFontSize" RibbonStyle="SmallWithoutText" EditWidth="90"
                 Content="Font Size:" 
                 EditValueChanged="eFontSize_EditValueChanged">
                <dxb:BarEditItem.EditSettings>
                    <dxe:ComboBoxEditSettings PopupMaxHeight="250" IsTextEditable="False"/>
                </dxb:BarEditItem.EditSettings>
            </dxb:BarEditItem>


        </dxr:RibbonPageGroup>
    </dxr:RibbonPage>
</dxr:RibbonPageCategory>

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

wpf-mvvm-behaviors-gallery-based-theme-palette-selector/CS/MainWindow.xaml#L16

<dxr:RibbonPageGroup Caption="Themes">
    <dxr:RibbonGalleryBarItem>
        <dxmvvm:Interaction.Behaviors>

how-to-apply-mvvm-to-the-ribboncontrol-the-gallery-collection-binding-e2599/CS/MainWindow.xaml#L35

<dxb:BarButtonItem x:Name="removeItem" Content="Remove" Command="{Binding DeleteCommand}" LargeGlyph="Icons/close-32x32.png"/>
<dxr:RibbonGalleryBarItem x:Name="itemPersons">
    <dxr:RibbonGalleryBarItem.Gallery>

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

<dxb:BarButtonItem x:Name="biChartSelectData" Command="{Binding ChartSelectData, Mode=OneTime, Source={StaticResource commands}}" />
<dxr:RibbonGalleryBarItem x:Name="biGalleryChartLayout">
    <dxr:RibbonGalleryBarItem.Gallery>

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

<dxb:BarButtonItem x:Name="biChartSelectData" Command="{Binding ChartSelectData, Mode=OneTime, Source={StaticResource commands}}" />
<dxr:RibbonGalleryBarItem x:Name="biGalleryChartLayout">
    <dxr:RibbonGalleryBarItem.Gallery>

wpf-create-a-ribboncontrol/CS/RibbonControl_Ex/MainWindow.xaml#L206

<!--region #RibbonGalleryBarItem-->
<dxr:RibbonGalleryBarItem Name="gFont" Glyph="{dxc:DXImage Image=ChangeFontStyle_16x16.png}" Content="Font">
    <dxr:RibbonGalleryBarItem.Links>