Привязка данных свойства enum к ComboBox в WPF

В качестве примера возьмем следующий код:

public enum ExampleEnum { FooBar, BarFoo }

public class ExampleClass : INotifyPropertyChanged
{
    private ExampleEnum example;

    public ExampleEnum ExampleProperty 
    { get { return example; } { /* set and notify */; } }
}

Я хочу связать свойство ExampleProperty с ComboBox, чтобы оно отображало параметры «FooBar» и «BarFoo» и работало в режиме TwoWay. Оптимально, я хочу, чтобы мое определение ComboBox выглядело примерно так:

<ComboBox ItemsSource="What goes here?" SelectedItem="{Binding Path=ExampleProperty}" />

В настоящее время в моем окне установлены обработчики для событий ComboBox.SelectionChanged и ExampleClass.PropertyChanged, где я выполняю привязку вручную.

Есть ли лучший или какой-то канонический способ? Вы обычно используете конвертеры и как бы вы заполнили ComboBox правильными значениями? Я даже не хочу начинать с i18n прямо сейчас.

редактировать

Поэтому был дан ответ на один вопрос: как мне заполнить ComboBox правильными значениями.

Получить значения Enum в виде списка строк через ObjectDataProvider из статического метода Enum.GetValues:

<Window.Resources>
    <ObjectDataProvider MethodName="GetValues"
        ObjectType="{x:Type sys:Enum}"
        x:Key="ExampleEnumValues">
        <ObjectDataProvider.MethodParameters>
            <x:Type TypeName="ExampleEnum" />
        </ObjectDataProvider.MethodParameters>
    </ObjectDataProvider>
</Window.Resources>

Это я могу использовать в качестве ItemsSource для моего ComboBox:

<ComboBox ItemsSource="{Binding Source={StaticResource ExampleEnumValues}}"/>

Вы можете создать собственное расширение разметки.

Пример использования:

enum Status
{
    [Description("Available.")]
    Available,
    [Description("Not here right now.")]
    Away,
    [Description("I don't have time right now.")]
    Busy
}

В верхней части вашего XAML:

    xmlns:my="clr-namespace:namespace_to_enumeration_extension_class

а потом...

<ComboBox 
    ItemsSource="{Binding Source={my:Enumeration {x:Type my:Status}}}" 
    DisplayMemberPath="Description" 
    SelectedValue="{Binding CurrentStatus}"  
    SelectedValuePath="Value"  /> 

И реализация ...

public class EnumerationExtension : MarkupExtension
  {
    private Type _enumType;


    public EnumerationExtension(Type enumType)
    {
      if (enumType == null)
        throw new ArgumentNullException("enumType");

      EnumType = enumType;
    }

    public Type EnumType
    {
      get { return _enumType; }
      private set
      {
        if (_enumType == value)
          return;

        var enumType = Nullable.GetUnderlyingType(value) ?? value;

        if (enumType.IsEnum == false)
          throw new ArgumentException("Type must be an Enum.");

        _enumType = value;
      }
    }

    public override object ProvideValue(IServiceProvider serviceProvider)
    {
      var enumValues = Enum.GetValues(EnumType);

      return (
        from object enumValue in enumValues
        select new EnumerationMember{
          Value = enumValue,
          Description = GetDescription(enumValue)
        }).ToArray();
    }

    private string GetDescription(object enumValue)
    {
      var descriptionAttribute = EnumType
        .GetField(enumValue.ToString())
        .GetCustomAttributes(typeof (DescriptionAttribute), false)
        .FirstOrDefault() as DescriptionAttribute;


      return descriptionAttribute != null
        ? descriptionAttribute.Description
        : enumValue.ToString();
    }

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

В viewmodel вы можете иметь:

public MyEnumType SelectedMyEnumType 
{
    get { return _selectedMyEnumType; }
    set { 
            _selectedMyEnumType = value;
            OnPropertyChanged("SelectedMyEnumType");
        }
}

public IEnumerable<MyEnumType> MyEnumTypeValues
{
    get
    {
        return Enum.GetValues(typeof(MyEnumType))
            .Cast<MyEnumType>();
    }
}

В XAML ItemSourceсвязывает MyEnumTypeValuesи SelectedItemсвязывает SelectedMyEnumType.

<ComboBox SelectedItem="{Binding SelectedMyEnumType}" ItemsSource="{Binding MyEnumTypeValues}"></ComboBox>

Я предпочитаю не использовать имя enum в пользовательском интерфейсе. Я предпочитаю использовать разные значения для user ( DisplayMemberPath) и разные для значения (в данном случае enum) ( SelectedValuePath). Эти два значения могут быть упакованы вKeyValuePair и сохранены в словаре.

XAML

<ComboBox Name="fooBarComboBox" 
          ItemsSource="{Binding Path=ExampleEnumsWithCaptions}" 
          DisplayMemberPath="Value" 
          SelectedValuePath="Key"
          SelectedValue="{Binding Path=ExampleProperty, Mode=TwoWay}" > 

C #

public Dictionary<ExampleEnum, string> ExampleEnumsWithCaptions { get; } =
    new Dictionary<ExampleEnum, string>()
    {
        {ExampleEnum.FooBar, "Foo Bar"},
        {ExampleEnum.BarFoo, "Reversed Foo Bar"},
        //{ExampleEnum.None, "Hidden in UI"},
    };


private ExampleEnum example;
public ExampleEnum ExampleProperty
{
    get { return example; }
    set { /* set and notify */; }
}

РЕДАКТИРОВАТЬ: Совместимо с шаблоном MVVM.

Я не знаю, возможно ли это только в XAML, но попробуйте следующее:

Дайте вашему ComboBox имя, чтобы вы могли получить к нему доступ в следующем коде: "typesComboBox1"

Теперь попробуйте следующее

typesComboBox1.ItemsSource = Enum.GetValues(typeof(ExampleEnum));

На основании принятого, но теперь удаленного ответа, предоставленного ageektrapped я создал уменьшенную версию без некоторых более продвинутых функций. Весь код включен сюда, чтобы вы могли скопировать и вставить его, а не блокировать с помощью link-rot.

Я использую тот, System.ComponentModel.DescriptionAttributeкоторый действительно предназначен для описания времени проектирования. Если вам не нравится использовать этот атрибут, вы можете создать свой собственный, но я думаю, что использование этого атрибута действительно делает свою работу. Если вы не используете атрибут, имя по умолчанию будет соответствовать названию значения перечисления в коде.

public enum ExampleEnum {

  [Description("Foo Bar")]
  FooBar,

  [Description("Bar Foo")]
  BarFoo

}

Вот класс, используемый в качестве источника элементов:

public class EnumItemsSource : Collection<String>, IValueConverter {

  Type type;

  IDictionary<Object, Object> valueToNameMap;

  IDictionary<Object, Object> nameToValueMap;

  public Type Type {
    get { return this.type; }
    set {
      if (!value.IsEnum)
        throw new ArgumentException("Type is not an enum.", "value");
      this.type = value;
      Initialize();
    }
  }

  public Object Convert(Object value, Type targetType, Object parameter, CultureInfo culture) {
    return this.valueToNameMap[value];
  }

  public Object ConvertBack(Object value, Type targetType, Object parameter, CultureInfo culture) {
    return this.nameToValueMap[value];
  }

  void Initialize() {
    this.valueToNameMap = this.type
      .GetFields(BindingFlags.Static | BindingFlags.Public)
      .ToDictionary(fi => fi.GetValue(null), GetDescription);
    this.nameToValueMap = this.valueToNameMap
      .ToDictionary(kvp => kvp.Value, kvp => kvp.Key);
    Clear();
    foreach (String name in this.nameToValueMap.Keys)
      Add(name);
  }

  static Object GetDescription(FieldInfo fieldInfo) {
    var descriptionAttribute =
      (DescriptionAttribute) Attribute.GetCustomAttribute(fieldInfo, typeof(DescriptionAttribute));
    return descriptionAttribute != null ? descriptionAttribute.Description : fieldInfo.Name;
  }

}

Вы можете использовать его в XAML следующим образом:

<Windows.Resources>
  <local:EnumItemsSource
    x:Key="ExampleEnumItemsSource"
    Type="{x:Type local:ExampleEnum}"/>
</Windows.Resources>
<ComboBox
  ItemsSource="{StaticResource ExampleEnumItemsSource}"
  SelectedValue="{Binding ExampleProperty, Converter={StaticResource ExampleEnumItemsSource}}"/> 

Используйте ObjectDataProvider:

<ObjectDataProvider x:Key="enumValues"
   MethodName="GetValues" ObjectType="{x:Type System:Enum}">
      <ObjectDataProvider.MethodParameters>
           <x:Type TypeName="local:ExampleEnum"/>
      </ObjectDataProvider.MethodParameters>
 </ObjectDataProvider>

а затем привязать к статическому ресурсу:

ItemsSource="{Binding Source={StaticResource enumValues}}"

Найти это решение в этом блоге

Мой любимый способ сделать это с помощью ValueConverterтак, чтобы ItemsSource и SelectedValue связывались с одним и тем же свойством. Это не требует никаких дополнительных свойств, чтобы ваша ViewModel была красивой и чистой.

<ComboBox ItemsSource="{Binding Path=ExampleProperty, Converter={x:EnumToCollectionConverter}, Mode=OneTime}"
          SelectedValuePath="Value"
          DisplayMemberPath="Description"
          SelectedValue="{Binding Path=ExampleProperty}" />

И определение конвертера:

public static class EnumHelper
{
  public static string Description(this Enum e)
  {
    return (e.GetType()
             .GetField(e.ToString())
             .GetCustomAttributes(typeof(DescriptionAttribute), false)
             .FirstOrDefault() as DescriptionAttribute)?.Description ?? e.ToString();
  }
}

[ValueConversion(typeof(Enum), typeof(IEnumerable<ValueDescription>))]
public class EnumToCollectionConverter : MarkupExtension, IValueConverter
{
  public object Convert(object value, Type targetType, object parameter, CultureInfo culture)
  {
    return Enum.GetValues(value.GetType())
               .Cast<Enum>()
               .Select(e => new ValueDescription() { Value = e, Description = e.Description()})
               .ToList();
  }
  public object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)
  {
    return null;
  }
  public override object ProvideValue(IServiceProvider serviceProvider)
  {
    return this;
  }
}

Этот конвертер будет работать с любым перечислением. ValueDescriptionэто просто простой класс со Valueсвойством и Descriptionсвойством. Вы также можете легко использовать Tupleс Item1и и Item2или KeyValuePairс Keyи Valueвместо значения и описания или любой другой класс по вашему выбору, если он может содержать значение перечисления и строковое описание этого значения перечисления.

Вот общее решение с использованием вспомогательного метода. Это также может обрабатывать перечисление любого базового типа (байт, sbyte, uint, long и т. Д.)

Вспомогательный метод:

static IEnumerable<object> GetEnum<T>() {
    var type    = typeof(T);
    var names   = Enum.GetNames(type);
    var values  = Enum.GetValues(type);
    var pairs   =
        Enumerable.Range(0, names.Length)
        .Select(i => new {
                Name    = names.GetValue(i)
            ,   Value   = values.GetValue(i) })
        .OrderBy(pair => pair.Name);
    return pairs;
}//method

Посмотреть модель:

public IEnumerable<object> EnumSearchTypes {
    get {
        return GetEnum<SearchTypes>();
    }
}//property

Поле со списком:

<ComboBox
    SelectedValue       ="{Binding SearchType}"
    ItemsSource         ="{Binding EnumSearchTypes}"
    DisplayMemberPath   ="Name"
    SelectedValuePath   ="Value"
/>

Вы можете рассмотреть что-то вроде этого:

1. Определите стиль для текстового блока или любого другого элемента управления, который вы хотите использовать для отображения вашего перечисления:

   <Style x:Key="enumStyle" TargetType="{x:Type TextBlock}">
       <Setter Property="Text" Value="&lt;NULL&gt;"/>
       <Style.Triggers>
           <Trigger Property="Tag">
               <Trigger.Value>
                   <proj:YourEnum>Value1<proj:YourEnum>
               </Trigger.Value>
               <Setter Property="Text" Value="{DynamicResource yourFriendlyValue1}"/>
           </Trigger>
           <!-- add more triggers here to reflect your enum -->
       </Style.Triggers>
   </Style>

2. определите свой стиль для ComboBoxItem

   <Style TargetType="{x:Type ComboBoxItem}">
       <Setter Property="ContentTemplate">
           <Setter.Value>
               <DataTemplate>
                   <TextBlock Tag="{Binding}" Style="{StaticResource enumStyle}"/>
               </DataTemplate>
           </Setter.Value>
       </Setter>
   </Style>

3. добавьте комбинированный список и загрузите его с вашими значениями перечисления:

   <ComboBox SelectedValue="{Binding Path=your property goes here}" SelectedValuePath="Content">
       <ComboBox.Items>
           <ComboBoxItem>
               <proj:YourEnum>Value1</proj:YourEnum>
           </ComboBoxItem>
       </ComboBox.Items>
   </ComboBox>

если ваше перечисление велико, вы, конечно, можете сделать то же самое в коде, не тратя много времени на ввод текста. Мне нравится такой подход, поскольку он упрощает локализацию - вы определяете все шаблоны один раз, а затем обновляете только файлы строковых ресурсов.

Если вы используете MVVM, основываясь на ответе @rudigrobler, вы можете сделать следующее:

Добавьте следующее свойство в класс ViewModel

public Array ExampleEnumValues => Enum.GetValues(typeof(ExampleEnum));

Затем в XAML сделайте следующее:

<ComboBox ItemsSource="{Binding ExampleEnumValues}" ... />

Это DevExpressконкретный ответ, основанный на ответе с Gregor S.наибольшим количеством голосов (в настоящее время он имеет 128 голосов).

Это означает, что мы можем поддерживать согласованность стилей во всем приложении:

К сожалению, оригинальный ответ не работает с ComboBoxEdit DevExpress без некоторых модификаций.

Во-первых, XAML для ComboBoxEdit:

<dxe:ComboBoxEdit ItemsSource="{Binding Source={xamlExtensions:XamlExtensionEnumDropdown {x:myEnum:EnumFilter}}}"
    SelectedItem="{Binding BrokerOrderBookingFilterSelected, Mode=TwoWay, UpdateSourceTrigger=PropertyChanged}"
    DisplayMember="Description"
    MinWidth="144" Margin="5" 
    HorizontalAlignment="Left"
    IsTextEditable="False"
    ValidateOnTextInput="False"
    AutoComplete="False"
    IncrementalFiltering="True"
    FilterCondition="Like"
    ImmediatePopup="True"/>

Нет необходимости говорить, что вам нужно указать xamlExtensionsна пространство имен, которое содержит класс расширения XAML (который определен ниже):

xmlns:xamlExtensions="clr-namespace:XamlExtensions"

И мы должны указать myEnumна пространство имен, которое содержит перечисление:

xmlns:myEnum="clr-namespace:MyNamespace"

Затем перечисление:

namespace MyNamespace
{
    public enum EnumFilter
    {
        [Description("Free as a bird")]
        Free = 0,

        [Description("I'm Somewhat Busy")]
        SomewhatBusy = 1,

        [Description("I'm Really Busy")]
        ReallyBusy = 2
    }
}

Проблема с XAML заключается в том, что мы не можем использовать SelectedItemValue, поскольку это приводит к ошибке, так как установщик недоступен (немного упущения с вашей стороны, DevExpress). Таким образом, мы должны изменить нашViewModel чтобы получить значение непосредственно из объекта:

private EnumFilter _filterSelected = EnumFilter.All;
public object FilterSelected
{
    get
    {
        return (EnumFilter)_filterSelected;
    }
    set
    {
        var x = (XamlExtensionEnumDropdown.EnumerationMember)value;
        if (x != null)
        {
            _filterSelected = (EnumFilter)x.Value;
        }
        OnPropertyChanged("FilterSelected");
    }
}

Для полноты вот расширение XAML из исходного ответа (слегка переименованное):

namespace XamlExtensions
{
    /// <summary>
    ///     Intent: XAML markup extension to add support for enums into any dropdown box, see http://bit.ly/1g70oJy. We can name the items in the
    ///     dropdown box by using the [Description] attribute on the enum values.
    /// </summary>
    public class XamlExtensionEnumDropdown : MarkupExtension
    {
        private Type _enumType;


        public XamlExtensionEnumDropdown(Type enumType)
        {
            if (enumType == null)
            {
                throw new ArgumentNullException("enumType");
            }

            EnumType = enumType;
        }

        public Type EnumType
        {
            get { return _enumType; }
            private set
            {
                if (_enumType == value)
                {
                    return;
                }

                var enumType = Nullable.GetUnderlyingType(value) ?? value;

                if (enumType.IsEnum == false)
                {
                    throw new ArgumentException("Type must be an Enum.");
                }

                _enumType = value;
            }
        }

        public override object ProvideValue(IServiceProvider serviceProvider)
        {
            var enumValues = Enum.GetValues(EnumType);

            return (
                from object enumValue in enumValues
                select new EnumerationMember
                       {
                           Value = enumValue,
                           Description = GetDescription(enumValue)
                       }).ToArray();
        }

        private string GetDescription(object enumValue)
        {
            var descriptionAttribute = EnumType
                .GetField(enumValue.ToString())
                .GetCustomAttributes(typeof (DescriptionAttribute), false)
                .FirstOrDefault() as DescriptionAttribute;


            return descriptionAttribute != null
                ? descriptionAttribute.Description
                : enumValue.ToString();
        }

        #region Nested type: EnumerationMember
        public class EnumerationMember
        {
            public string Description { get; set; }
            public object Value { get; set; }
        }
        #endregion
    }
}

Отказ от ответственности: я не имею никакого отношения к DevExpress. Telerik также отличная библиотека.

Попробуйте использовать

<ComboBox ItemsSource="{Binding Source={StaticResource ExampleEnumValues}}"
    SelectedValue="{Binding Path=ExampleProperty}" />

Я создал проект CodePlex с открытым исходным кодом, который делает это. Вы можете скачать пакет NuGet здесь .

<enumComboBox:EnumComboBox EnumType="{x:Type demoApplication:Status}" SelectedValue="{Binding Status}" />