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

LEAP Sweden - Identity & Access Management

Today was the third day of the Swedish Lead Enterprise Architect Program at Microsoft in Kista. It has been a day filled with sessions on security and identity with a kind of unavoidable focus on federated identities in the cloud. Overall it has been an awesome day with seminars from Henrik Nilsson , Barry O'Reilly and Sergio Molero among others. A lot of Microsoft technologies was mentioned, Forefront Identity Manager , Active Directory Federation Services 2.0 , Forefront Unified Access Gateway , Direct Access ,  Windows Identity Framework and of course  Azure Access Control Service . Microsoft really has a great suite of applications regarding Identity & Access Management. I just wish there was a project or two where I could utilize all of these amazing technologies. I have had a plan to add a login feature to the Cornball using federated identities, so that might happen in the near future. Besides, Björn Eriksen provided a tip for all of us thursty for e...

The Cornball goes to Brunch with Chaplin

Lately I've been working pretty hard on different projects but not really stumbling upon anything blogworthy. The most recent project is quite interesting though, a single page, touch friendly, web application using the latest and greatest technologies. We've ended up with using Brunch with Chaplin , which is a very neat way of setting up a Backbone based single page web project with Brunch and Chaplin . Aside from this, I have my own little project that has lived on for almost 15 years already, The Cornball . From being a plain Windows application written i C an Win32 API, it has been ported to .NET using WPF, and is currently a Silverlight application hosted on Windows Azure. I could not find a better time to reanimate this project and create a new web based version, touch friendly, super optimized, awesome in any way. So I did... So please follow my journey at Github . It's going to take a while, I assure you, but I already have some ground work done. Meanwhile,...

Using ASP.NET MVC with MEF

I wrote this post almost a year ago, but never published it for some reason. Anyway, here is a little MVC/MEF magic. By default a controller in MVC must have a parameterless constructor. When using MEF a good practice is to inject the services via constructor parameters. These two in combination obviously creates an issue where the following scenario will not work out of the box, since there is no parameterless constructor for  MVC  to use. Note that the PartCreationPolicy is set to NonShared since a new controller have to be initialized for each request. [Export] [PartCreationPolicy(CreationPolicy.NonShared)] public class HomeController : Controller {     private readonly IServiceClient _service;     [ImportingConstructor]     public HomeController(IServiceClient service)     {         _service = service;     }     public ActionResult Index()     {         ...