RibbonPageGroup.CaptionButtonCommandTarget Property

Gets or sets the element on which to raise the RibbonPageGroup.CaptionButtonCommand. This is a dependency property.

Namespace: DevExpress.Xpf.Ribbon

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

Declaration

C#

public IInputElement CaptionButtonCommandTarget { get; set; }

VB.NET

Public Property CaptionButtonCommandTarget As IInputElement

Property Value

Type	Description
IInputElement	The element on which to raise the RibbonPageGroup.CaptionButtonCommand.

Remarks

To learn how commands are applied to group Caption Buttons, see the example below.

Example

The following figure illustrates a RibbonControl containing a ‘Font’ RibbonPageGroup that has a Caption Button (hovered by the mouse cursor in the figure). The example demonstrates how to attach a command to a Caption Button via the RibbonPageGroup.CaptionButtonCommand property.

When the Caption Button is clicked, the ‘Font Preferences’ window is displayed.

C#

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;
using DevExpress.Xpf.Ribbon;

namespace RibbonCustomization {
    /// <summary>
    /// Interaction logic for MainWindow.xaml
    /// </summary>
    public partial class MainWindow : Window {
        public static RoutedCommand FontOptionsMenu = new RoutedCommand();
        public MainWindow() {
            DevExpress.Xpf.Core.ApplicationThemeHelper.ApplicationThemeName = "Seven";
            InitializeComponent();

        }
        private void FontOptionsMenuExecuted(object sender, ExecutedRoutedEventArgs e) {
            new FontMenuWindow().Show();
        }

        private void FontOptionsMenuExecute(object sender, CanExecuteRoutedEventArgs e) {
            e.CanExecute = true;
        }
    }
}

XAML

Main Ribbon Window Xaml File
<Window x:Class="RibbonCustomization.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:dx="http://schemas.devexpress.com/winfx/2008/xaml/core"
        xmlns:dxb="http://schemas.devexpress.com/winfx/2008/xaml/bars"
        xmlns:dxdb="http://schemas.devexpress.com/winfx/2008/xaml/demobase"
        xmlns:dxe="http://schemas.devexpress.com/winfx/2008/xaml/editors"
        xmlns:dxr="http://schemas.devexpress.com/winfx/2008/xaml/ribbon"
        xmlns:custom="clr-namespace:RibbonCustomization"
        Title="Ribbon Customization guide" Height="350" Width="525">

    <Window.CommandBindings>
        <CommandBinding Command="{x:Static custom:MainWindow.FontOptionsMenu}"
                    Executed="FontOptionsMenuExecuted"
                    CanExecute="FontOptionsMenuExecute"/>
    </Window.CommandBindings>

    <Grid Name="mainGrid">
        <dxb:BarManager Name="myBarManager">
            ...
                <dxr:RibbonControl Name="myRibbonControl" Grid.Row="0">
                ...
                    <dxr:RibbonDefaultPageCategory Caption="defaultCategory" Name="ribbonDefaultPageCategory">
                    ...
                            <dxr:RibbonPageGroup Caption="Font" Name="pgFont" ShowCaptionButton="True" CaptionButtonCommand="{x:Static custom:MainWindow.FontOptionsMenu}">
                                <dxb:BarSubItemLink BarItemName="siFontFamily" BarItemDisplayMode="Default" />
                                <dxb:BarSubItemLink BarItemName="siFontSize" />
                                <dxb:BarButtonItemLink BarItemName="biBold" />
                                <dxb:BarButtonItemLink BarItemName="biItalic" />
                                <dxb:BarButtonItemLink BarItemName="biUnderlined" />
                            </dxr:RibbonPageGroup>
                            ...
                    </dxr:RibbonDefaultPageCategory>
                    ...
                </dxr:RibbonControl>
                ...
        </dxb:BarManager>
    </Grid>
</Window>