RibbonCustomItem Class

A custom item within a RibbonControl.

Assembly: DevExpress.WinUI.Ribbon.v23.2.dll

Declaration

C#
VB.NET

[ContentProperty(Name = "Content")]
public class RibbonCustomItem :
    RibbonItemBase,
    IRibbonItem,
    IRibbonItemBase,
    ISupportToolTip

<ContentProperty(Name:="Content")>
Public Class RibbonCustomItem
    Inherits RibbonItemBase
    Implements IRibbonItem,
               IRibbonItemBase,
               ISupportToolTip

Remarks

The following code sample displays ComboBox in the RibbonControl‘s custom item:

MainWindow.xaml

<Window ... 
    xmlns:dxr="using:DevExpress.WinUI.Ribbon">
    <Grid>
        <dxr:RibbonControl>
            <dxr:RibbonControl.Tabs>
                <dxr:RibbonTab Caption="Home">
                    <dxr:RibbonGroup Caption="Font">
                        <dxr:RibbonCustomItem ItemType="Small">
                            <ComboBox ItemsSource="{x:Bind ViewModel.Values}" />
                        </dxr:RibbonCustomItem>
                    </dxr:RibbonGroup>
                </dxr:RibbonTab>
            </dxr:RibbonControl.Tabs>
        </dxr:RibbonControl>
    </Grid>
</Window>

MainWindow.xaml.cs

using DevExpress.Mvvm;
// ...
    public sealed partial class MainWindow : Window {
        public MainWindowViewModel ViewModel = new MainWindowViewModel();
        public MainWindow() {
            this.InitializeComponent();
        }
    }

    public class MainWindowViewModel : ViewModelBase {
        public ObservableCollection<int> Values {
            get => GetValue<ObservableCollection<int>>();
            set => SetValue(value);
        }
        public MainWindowViewModel() {
            Values = new ObservableCollection<int>();
            for (int i = 8; i <= 20; i += 2)
                Values.Add(i);
        } 
    }

WinUI RibbonControl - Custom Item Combobox

Customize a RibbonCustomItem’s Size

The RibbonCustomItem class contains the DisplayMode property that defines a custom item’s size.

Property	Description	Image
Large	The large item (100px height).
Small	The small item (32px height).

Tool Tip

You can use the following properties to display a RibbonCustomItem‘s tooltip:

Property	Description
ToolTip	Gets or sets the ribbon custom item’s tooltip. This is a dependency property.
ToolTipDescription	Gets or sets the ribbon custom item’s tooltip description text that is displayed under the ToolTipTitle. This is a dependency property.
ToolTipTitle	Gets or sets the ribbon custom item’s tooltip title text. This is a dependency property.