You are viewing help content for pre-release software. This document and the features it describes are subject to change. Switch to the current version.

RibbonGalleryBarItem Class

A bar item that displays a gallery.

Namespace: DevExpress.Xpf.Ribbon

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

Declaration

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.

Examples

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

View Example

<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>
See Also