Skip to main content

Managing themes in WPF

Having just published Simple.Wpf.Terminal as a nuget package I wanted the ability to skin the user control - the more flexibility in the way it looks the more likely it will be used by other devs :)

Before getting into the detail, lets look at the solution working in the test harness for my WPF F# REPL Engine, shown below are four different themes applied dynamically at run-time - no recompilation required to change the theme:
Previously in larger WPF apps I've relied upon third-party control vendors like Telerik to provide theming support. Typically they provide good solutions to the problem with multiple themes supported as standard, and when you're already using their third party controls the use of their themes makes sense. But when you're developing a small UI component you don't want to add (& support) such a large footprint just to add themes to your niche control.

A theme is a collection of Styles grouped into a ResourceDictionary in WPF. A Style can be applied to a control type, this is done either via the target type of via name (Key). Shown below is a very simple there with two styles defined, hopefully they are obvious but if not these two styles are targeting the Button & TextBlock controls:
A theme (resource dictionary) is then applied either at the application level to all controls in the visual tree or at the control level to all controls lower in the visual tree - scoping the theme to only a part of the visual tree.

How you apply the theme is what makes managing themes interesting, typically in an app which doesn't support changing the theme at run-time this would be done statically at compile time using XAML:
But this approach won't work when you want to be able to change the theme dynamically at run-time, you need to do this in code behind, and this is where a theme manager comes into play.

The solution I wanted was to provide a simple UI (combo box) allowing the user to select a theme which is then dynamically applied to the UI. The UI control manipulates a globally defined theme manager - defined globally as a static class:
The control exposes three dependency properties - ItemsSource, SelectedItem & Scope.

These allow the setting, selecting and scoping of the theme you want to apply to the app. As stated earlier the actual manipulating was done using a theme manager class, this means you aren't required to use UI (combo box) to manage themes. The theme manager implementation is shown below, as you can see it's pretty straight forward manipulation of resource dictionaries:

Loading gist ....

The following example shows how I use the control in a code-behind approach - there's an MVVM approach included in the code base on github:
 with the following code behind, note the use of the Theme class to bring to together the user friendly name and the actual URI of the resource dictionary:
 and finally the following XAML definition:
Hopefully you can see you don't need to actually use the ThemeManager class directly, this is done for you by the Theme user control.

I've pushed the code up onto github and as a nuget package.


Popular posts from this blog

WPF tips & tricks: Dispatcher thread performance

Not blogged for an age, and I received an email last week which provoked me back to life. It was a job spec for a WPF contract where they want help sorting out the performance of their app especially around grids and tabular data. I thought I'd shared some tips & tricks I've picked up along the way, these aren't probably going to solve any issues you might be having directly, but they might point you in the right direction when trying to find and resolve performance issues with a WPF app. First off, performance is something you shouldn't try and improve without evidence, and this means having evidence proving you've improved the performance - before & after metrics for example. Without this you're basically pissing into the wind, which can be fun from a developer point of view but bad for a project :) So, what do I mean by ' Dispatcher thread performance '? The 'dispatcher thread' or the 'UI thread' is probably the most

Showing a message box from a ViewModel in MVVM

I was doing a code review with a client last week for a WPF app using MVVM and they asked ' How can I show a message from the ViewModel? '. What follows is how I would (and have) solved the problem in the past. When I hear the words ' show a message... ' I instantly think you mean show a transient modal message box that requires the user input before continuing ' with something else ' - once the user has interacted with the message box it will disappear. The following solution only applies to this scenario. The first solution is the easiest but is very wrong from a separation perspective. It violates the ideas behind the Model-View-Controller pattern because it places View concerns inside the ViewModel - the ViewModel now knows about the type of the View and specifically it knows how to show a message box window: The second approach addresses this concern by introducing the idea of messaging\events between the ViewModel and the View. In the example below

Implementing a busy indicator using a visual overlay in MVVM

This is a technique we use at work to lock the UI whilst some long running process is happening - preventing the user clicking on stuff whilst it's retrieving or rendering data. Now we could have done this by launching a child dialog window but that feels rather out of date and clumsy, we wanted a more modern pattern similar to the way <div> overlays are done on the web. Imagine we have the following simple WPF app and when 'Click' is pressed a busy waiting overlay is shown for the duration entered into the text box. What I'm interested in here is not the actual UI element of the busy indicator but how I go about getting this to show & hide from when using MVVM. The actual UI elements are the standard Busy Indicator coming from the WPF Toolkit : The XAML behind this window is very simple, the important part is the ViewHost. As you can see the ViewHost uses a ContentPresenter element which is bound to the view model, IMainViewModel, it contains 3 child v