BarSubItemThemeSelectorBehavior Class

Populates the associated BarSubItem with available themes and allows you to choose the application’s theme.

Namespace: DevExpress.Xpf.Bars

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

NuGet Package: DevExpress.Wpf.Core

Declaration

C#

[TargetType(typeof(BarSubItem))]
public class BarSubItemThemeSelectorBehavior :
    BarItemThemeSelectorBehavior<BarSubItem>

VB.NET

<TargetType(GetType(BarSubItem))>
Public Class BarSubItemThemeSelectorBehavior
    Inherits BarItemThemeSelectorBehavior(Of BarSubItem)

Remarks

To use the BarSubItemThemeSelectorBehavior, attach it to a BarSubItem in a RibbonControl.

XAML

<Window ...
    xmlns:dxb="http://schemas.devexpress.com/winfx/2008/xaml/bars"
    xmlns:dxr="http://schemas.devexpress.com/winfx/2008/xaml/ribbon"
    xmlns:dxmvvm="http://schemas.devexpress.com/winfx/2008/xaml/mvvm">
    <StackPanel>
        <dxr:RibbonControl>
            <dxr:RibbonDefaultPageCategory>
                <dxr:RibbonPage Caption="Theme">
                    <dxr:RibbonPageGroup Caption="Application Theme">
                        <dxb:BarSubItem>
                            <dxmvvm:Interaction.Behaviors>
                                <dxb:BarSubItemThemeSelectorBehavior />
                            </dxmvvm:Interaction.Behaviors>
                        </dxb:BarSubItem>
                    </dxr:RibbonPageGroup>
                </dxr:RibbonPage>
            </dxr:RibbonDefaultPageCategory>
        </dxr:RibbonControl>
    </StackPanel>
</Window>

View Example

Display Modes

You can use the BarSubItemThemeSelectorBehavior.ShowMode property to choose any of the following display modes:

List

Themes are displayed in a list.

GroupedList

Themes are displayed in a list and grouped by category.

GroupedInSubMenus

Themes are grouped by category and displayed in sub menus.

Persist Theme Selection between Application Runs

Use can save the application’s theme to the configuration file and restore it on the next application run.

To save an applied theme, use the static ApplicationThemeHelper.SaveApplicationThemeName method to save the theme name specified in the static ApplicationThemeHelper.ApplicationThemeName property:

App.xaml.cs

private void Application_Exit(object sender, StartupEventArgs e) {
    ApplicationThemeHelper.SaveApplicationThemeName();
}        

App.xaml.vb

Private Sub Application_Exit(ByVal sender As Object, ByVal e As StartupEventArgs)
    ApplicationThemeHelper.SaveApplicationThemeName()
End Sub

Call the static ApplicationThemeHelper.UpdateApplicationThemeName method to retrieve the theme name from the configuration file and apply it to your application:

App.xaml.cs

private void Application_Startup(object sender, ExitEventArgs e) {
    ApplicationThemeHelper.UpdateApplicationThemeName();
}

App.xaml.vb

Private Sub Application_Startup(ByVal sender As Object, ByVal e As StartupEventArgs)
    ApplicationThemeHelper.UpdateApplicationThemeName()
End Sub

Display Windows System Color Theme

You can set the inherited ShowWin10SystemColorTheme property to true to display the Windows 10 System Colors theme in the theme selector. This theme takes the Windows app mode and accent color settings, applies it to your application, and updates your app appearance when a user changes these OS settings.

Refer to the following topic for more information: Use Windows Accent Color and App Mode.

Hide Themes from Theme Selector

You can use the Theme.ShowInThemeSelector property to hide a theme/theme category from the BarSubItemThemeSelectorBehavior.

The following code sample hides the Office2007 and Metropolis theme categories, and the DeepBlue application theme:

MainWindow.xaml

<Window ...
    xmlns:dxb="http://schemas.devexpress.com/winfx/2008/xaml/bars"
    xmlns:dxr="http://schemas.devexpress.com/winfx/2008/xaml/ribbon"
    xmlns:dxmvvm="http://schemas.devexpress.com/winfx/2008/xaml/mvvm">
    <StackPanel>
        <dxr:RibbonControl>
            <dxr:RibbonDefaultPageCategory>
                <dxr:RibbonPage Caption="Theme">
                    <dxr:RibbonPageGroup Caption="Application Theme">
                        <dxb:BarSubItem>
                            <dxmvvm:Interaction.Behaviors>
                                <dxb:BarSubItemThemeSelectorBehavior/>
                            </dxmvvm:Interaction.Behaviors>
                        </dxb:BarSubItem>
                    </dxr:RibbonPageGroup>
                </dxr:RibbonPage>
            </dxr:RibbonDefaultPageCategory>
        </dxr:RibbonControl>
    </StackPanel>
</Window>

App.xaml.cs

using DevExpress.Xpf.Core;

public partial class App : Application {
    public App() {
        foreach (Theme theme in Theme.Themes.ToList()) {
            if (theme.Category == Theme.Office2007Category ||
                theme.Category == Theme.MetropolisCategory || 
                theme.Name == "DeepBlue") theme.ShowInThemeSelector = false;
        }
    }
}

App.xaml.vb

Imports DevExpress.Xpf.Core

Public Partial Class App
    Inherits Application

    Public Sub New()
        For Each theme As Theme In Theme.Themes.ToList()
            If theme.Category = Theme.Office2007Category OrElse theme.Category = Theme.MetropolisCategory OrElse theme.Name = "DeepBlue" Then theme.ShowInThemeSelector = False
        Next
    End Sub
End Class

Hide Touch Themes in XAML

Set the behavior’s inherited ShowTouchThemes property to false to hide touch themes from the BarSubItemThemeSelectorBehavior:

MainWindow.xaml

<Window ...
    xmlns:dxb="http://schemas.devexpress.com/winfx/2008/xaml/bars"
    xmlns:dxr="http://schemas.devexpress.com/winfx/2008/xaml/ribbon"
    xmlns:dxmvvm="http://schemas.devexpress.com/winfx/2008/xaml/mvvm">
    <StackPanel>
        <dxr:RibbonControl>
            <dxr:RibbonDefaultPageCategory>
                <dxr:RibbonPage Caption="Theme">
                    <dxr:RibbonPageGroup Caption="Application Theme">
                        <dxb:BarSubItem>
                            <dxmvvm:Interaction.Behaviors>
                                <dxb:BarSubItemThemeSelectorBehavior ShowTouchThemes="False" />
                            </dxmvvm:Interaction.Behaviors>
                        </dxb:BarSubItem>
                    </dxr:RibbonPageGroup>
                </dxr:RibbonPage>
            </dxr:RibbonDefaultPageCategory>
        </dxr:RibbonControl>
    </StackPanel>
</Window>

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the BarSubItemThemeSelectorBehavior 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

wpf-mvvm-behaviors-barItems-based-theme-selectors/CS/WpfApplication1/MainWindow.xaml#L55

<dxmvvm:Interaction.Behaviors>
    <dxb:BarSubItemThemeSelectorBehavior ShowMode="GroupedInSubMenus" />
</dxmvvm:Interaction.Behaviors>

Inheritance

Show 11 items

Object

DispatcherObject

DependencyObject

Freezable

Animatable

DevExpress.Mvvm.UI.Interactivity.AttachableObjectBase

DevExpress.Mvvm.UI.Interactivity.Behavior

DevExpress.Mvvm.UI.Interactivity.Behavior<BarSubItem>

DevExpress.Xpf.Bars.ThemeSelectorBehavior<BarSubItem>

DevExpress.Xpf.Bars.BarItemThemeSelectorBehavior<BarSubItem>

BarSubItemThemeSelectorBehavior