As you might have seen in the Windows Phone 7 Office application there are small round buttons in the panorama. As you should never use the application bar in the panorama it’s a good way to get some navigation points into the panorama. There are a few versions of this button out, ranging from styling a button and up to complete controls. However the ones I have found have things I don’t like, mostly they work with black and white images or with paths for the icon.
So I started out with a few basic specifications, I wanted:
- A simple control to use, no special content
- Only mage for the button (white with alpha channel)
- To be able to easily add content next to the button
- Ability to re-skin the button
The goal was to be able to define a button with just a simple:
<jc:RoundButton Image="/icons/refresh.png" Content="refresh" />
For those that don’t want to find out about my journey towards the RoundButton control there is a zip with the code and a sample project at the very bottom of the post…
When I first started out with the basic design the approach was the same as for others out there, two images that was swapped on light theme and shifted on pressed state. But I didn’t like it, I wanted the control to handle the image inversion stuff so my next thought was to create a new image with Writable bitmap and do some pixel magic, but before I got that far I stumbled on a blog post on displaying an image in the accent color. This was brilliant, using the image as a opacity mask, I could have whatever color I liked. So the core of the control got to be something like this:
<Rectangle x:Name="ImageForeground" Height="48" Width="48"
Fill="with_whatever_color_or_template_color">
<Rectangle.OpacityMask>
<ImageBrush ImageSource="image.png" Stretch="Fill" />
</Rectangle.OpacityMask>
</Rectangle>
The code
On to the control design, first of was to create the code behind for the button, creating the attached properties. This code ended up looking like this:
public class RoundButton : Button
{
private object _layoutRoot;
public static readonly DependencyProperty ImageProperty = DependencyProperty.Register("Image", typeof(ImageSource), typeof(RoundButton), null);
public RoundButton() : base()
{
DefaultStyleKey = typeof(RoundButton);
}
[Description("The image displayed by the button in dark theme (and in normal mode)"), Category("Common Properties")]
public ImageSource Image
{
get { return (ImageSource)GetValue(ImageProperty); }
set { SetValue(ImageProperty, value); }
}
public override void OnApplyTemplate()
{
_layoutRoot = GetTemplateChild( "LayoutRoot" ) as Border;
Debug.Assert( _layoutRoot != null, "LayoutRoot is null" );
base.OnApplyTemplate();
}
}
Hurdles and solutions
So the template stuff should be easy now right? Just add the Image to ImageSource for the Brush like this:
<ImageBrush ImageSource="{TemplateBinding Image}" Stretch="Fill" />
Wrong! Turns out you can’t bind to an ImageSource in an ImageBrush, because ImageBrush don’t inherit from FrameworkElement, as BMiloshevska pointed out. Argh, so close. Back to the drawing board until Derek Lakin pointed me at an article about using a converter as a workaround. Here is the converter stuff:
public class ImageBrushConverter : IValueConverter
{
public object Convert(object value, Type targetType, object parameter, CultureInfo culture)
{
BitmapImage image = (BitmapImage)value;
ImageBrush imageBrush = new ImageBrush();
if (image != null)
{
imageBrush.ImageSource = image;
}
return imageBrush;
}
public object ConvertBack(object value, Type targetType, object parameter, System.Globalization.CultureInfo culture)
{
throw new NotImplementedException();
}
}
Getting closer, but still there are a few hurdles left as you will see. Now it seems you can bind the ImageBrush to the DependecyProperty with a Converter, like this:
<ImageBrush ImageSource="{TemplateBinding Image, Converter={StaticResource brushConverter}}" Stretch="Fill" />
Wrong again! You can’t use a converter on a TemplateBinding, sigh. Then a new angle: The DataContext. You can TemplateBind the image to the DataContext and then use a normal binding (with converter) for the brush. Success! The binding ended up looking like this:
<Rectangle x:Name="ImageForeground" Height="48" Width="48"
Fill="{TemplateBinding Foreground}"
DataContext="{TemplateBinding Image}"
OpacityMask="{Binding Converter={StaticResource brushConverter}}" />
The template
So now it was the last part left, creating the template style with states for normal, pressed and disabled. The last one is a bonus, with the image approach you would now need three images, white, black and grey, no you can use whatever you like. The template was placed in Themes/generic.xaml and looks in part like this (the full xaml is included in the zip):
<Style TargetType="local:RoundButton">
<!-- Basic template setters -->
<Setter Property="Template">
<Setter.Value>
<ControlTemplate TargetType="local:RoundButton">
<Border x:Name="LayoutRoot" Background="Transparent" Padding="12" >
<VisualStateManager.VisualStateGroups>
<!-- The states Normal/Pressed/DIsabled/... -->
</VisualStateManager.VisualStateGroups>
<!-- The actual button template where the image and content goes -->
<Grid>
<StackPanel Orientation="Horizontal">
<Border Height="48" Width="48" x:Name="ButtonBackground" BorderThickness="3" CornerRadius="24" Background="{TemplateBinding Background}" BorderBrush="{TemplateBinding BorderBrush}" >
<Border.Resources>
<local:ImageBrushConverter x:Key="brushConverter"/>
</Border.Resources>
<Rectangle x:Name="ImageForeground" Height="48" Width="48" HorizontalAlignment="Center" VerticalAlignment="Center" Fill="{TemplateBinding Foreground}"
DataContext="{TemplateBinding Image}"
OpacityMask="{Binding Converter={StaticResource brushConverter}}" />
</Border>
<ContentControl VerticalAlignment="Center" Margin="0" HorizontalAlignment="Left" Padding="8,0,0,0" Content="{TemplateBinding Content}" />
</StackPanel>
</Grid>
</Border>
</ControlTemplate>
</Setter.Value>
</Setter>
</Style>
There, finally I reached my goal!
Improvements
So am I done now? Yes and no. The functionality is in place and the first four goals reached but there is more stuff I like to do:
- I want to add some optional animation, for example the push behavior from the AppBar and the tilt effect (actually you can use the tilt effect that Peter Torr blogged about, as the control is based on a button)
- I think there is a workaround to the Converter, I would like to eliminate that part.
- Also create a round toggle button with two images (for example play/pause media button)
If anyone happen to have a solution or idea around those issues I would be happy to know.
The zip includes the control and a test project to try it out.