Skip to main content

Binding Enum with DescriptionAttribute in WPF

Binding an enumeration to a ComboBox can be done in several ways. In most cases you don't want to display the value itself, but a more user friendly description. One common approach is to use the DescriptionAttribute on the Enum values to supply a description for each value. This is all possible in a very MVVM friendly way.

First step is to add the DescriptionAttribute to the values of the enumeration.

public enum MyValues
{
    [Description("First value")]
    First,

    [Description("Second value")]
    Second
}

To retrieve the description from the enum we use a simple extension method. This method returns the value of the DescriptionAttribute if it exists, otherwise the string representation of the enum value is returned.

public static string GetDescription(this Enum value)
{
    var fieldInfo = value.GetType().GetField(value.ToString());
    var attribute = fieldInfo.GetCustomAttributes(typeof(DescriptionAttribute), false).FirstOrDefault() as DescriptionAttribute;

    return attribute != null ? attribute.Description : value.ToString();
}

With this extension method it is really easy to write a generic enum description converter to use where ever an enum value is presented to the user. But the more interesting case is where we want to present the enumeration in a ComboBox or a similar control. To accomplish this you can use a MarkupExtension. (Please note that this code is stripped from all type validation and such to be easier to read.)

public class EnumExtension : MarkupExtension
{
    private readonly Type _enumType;

    public EnumExtension(Type enumType)
    {
        _enumType = enumType;
    }

    public override object ProvideValue(IServiceProvider serviceProvider)
    {
        return (from object enumValue in Enum.GetValues(_enumType)
                select new EnumMember {Value = enumValue, Description = ((Enum)enumValue).GetDescription()}).ToArray();
    }

    public class EnumMember
    {
        public string Description { get; set; }
        public object Value { get; set; }
    }
}

The DescriptionAttribute together with these extensions gives us a really neat way of populating the values of an enum into a ComboBox.

<ComboBox SelectedValue="{Binding MyValue}"
          ItemsSource="{Binding Source={my:EnumExtension {x:Type MyValues}}}"
          DisplayMemberPath="Description" SelectedValuePath="Value" />

Comments

  1. 1xbet 1xbet 10cric 10cric 카지노 카지노 온라인카지노 온라인카지노 1xbet 1xbet fun88 fun88 687

    ReplyDelete
  2. Tania's Pro Titanium Hockey VR - The Tania's Pro - Titanium
    Tania's Pro is titanium rod in leg an upcoming titanium hoop earrings video game developed by titanium tent stakes Tania titanium chain for HTC Vive, the HTC Vive, PC, micro touch titanium trimmer Vive, PlayStation VR and PlayStation VR.

    ReplyDelete

Post a Comment

Popular posts from this blog

Binding a HTML-formatted string to a WPF WebBrowser control

Sometimes there is a need to display a HTML formatted string in a WPF application. There are a couple of ways to do this, but the most stright forward is to use a WebBrowser control and the NavigateToString method. This approach has one big flaw, you cannot use binding to a string out of the box, but I found a great solution through Stack Overflow which adds a bindable property to the  WebBrowser  control using  NavigateToString . The following class is all that is needed to add that behavior. A new depencency property named Html is introduced to the  WebBrowser  and the proper change action is performed in the OnHtmlChanged method. public class BrowserBehavior { public static readonly DependencyProperty HtmlProperty = DependencyProperty.RegisterAttached( "Html", typeof(string), typeof(BrowserBehavior), new FrameworkPropertyMetadata(OnHtmlChanged)); [AttachedPropertyBrowsableForType(typeof(WebBrowser))] public static string GetHtml(WebBrowser bro

Bindable RichTextBox with HTML conversion in WPF

In WPF , the RichTextBox  control is not really like other controls. Due to its flexible nature, there is no built in way of binding a property to the content. In this case, I wanted a simple  RichTextBox  control with a binding to an HTML formatted string to be able to use the built-in formatting features of the  RichTextBox  and allow users to create simple HTML formatted content. First, doing the conversion on-the-fly proved to have major performance issues, so I ended up binding the content to a XAML string. The XAML to HTML conversion can be performed at any time. I created a UserControl with a bindable Text-property. The view contains a  RichTextBox  control. <RichTextBox x:Name="richTextBox" TextChanged="OnRichTextBoxChanged"> The source code for the user control contains the Text property and the methods to handle the binding. public static readonly DependencyProperty TextProperty = DependencyProperty.Register( "Text", typeof(st