Как привязать перечисление к элементу управления списком в WPF? - PullRequest
163 голосов
/ 27 мая 2011

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

В основном у меня есть класс, который содержит все свойства, которые я связываю, сначала устанавливая DataContext для этого класса,и затем указание привязки в файле xaml следующим образом:

<ComboBox ItemsSource="{Binding Path=EffectStyle}"/>

Но это не показывает значения перечисления в ComboBox как элементы.

Ответы [ 16 ]

276 голосов
/ 27 мая 2011

Вы можете сделать это из кода, поместив следующий код в обработчик событий Window Loaded, например:

yourComboBox.ItemsSource = Enum.GetValues(typeof(EffectStyle)).Cast<EffectStyle>();

Если вам нужно связать его в XAML, вам нужно использовать ObjectDataProvider длясоздать объект, доступный как источник привязки:

<Window x:Class="YourNamespace.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:System="clr-namespace:System;assembly=mscorlib"
        xmlns:StyleAlias="clr-namespace:Motion.VideoEffects">
    <Window.Resources>
        <ObjectDataProvider x:Key="dataFromEnum" MethodName="GetValues"
                            ObjectType="{x:Type System:Enum}">
            <ObjectDataProvider.MethodParameters>
                <x:Type TypeName="StyleAlias:EffectStyle"/>
            </ObjectDataProvider.MethodParameters>
        </ObjectDataProvider>
    </Window.Resources>
    <Grid>
        <ComboBox ItemsSource="{Binding Source={StaticResource dataFromEnum}}"
                  SelectedItem="{Binding Path=CurrentEffectStyle}" />
    </Grid>
</Window>

Обратите внимание на следующий код:

xmlns:System="clr-namespace:System;assembly=mscorlib"
xmlns:StyleAlias="clr-namespace:Motion.VideoEffects"

Руководство по отображению пространства имен и сборки, которые вы можете прочитать на MSDN .

101 голосов
/ 14 сентября 2012

Мне нравится, чтобы все объекты, которые я связываю, были определены в моем ViewModel, поэтому я стараюсь по возможности избегать использования <ObjectDataProvider> в xaml.

Мое решение не использует никаких данных, определенных в представлении, и никакого кода кода. Только DataBinding, повторно используемый ValueConverter, метод для получения коллекции описаний для любого типа Enum и одно свойство в ViewModel для привязки.

Когда я хочу связать Enum с ComboBox текстом, который я хочу отобразить, никогда не совпадает со значениями Enum, поэтому я использую атрибут [Description()], чтобы дать ему текст, который я на самом деле хочу чтобы увидеть в ComboBox. Если бы в игре было несколько классов персонажей, это выглядело бы примерно так:

public enum PlayerClass
{
  // add an optional blank value for default/no selection
  [Description("")]
  NOT_SET = 0,
  [Description("Shadow Knight")]
  SHADOW_KNIGHT,
  ...
}

Сначала я создал вспомогательный класс с парой методов для работы с перечислениями. Один метод получает описание для определенного значения, другой метод получает все значения и их описания для типа.

public static class EnumHelper
{
  public static string Description(this Enum value)
  {
    var attributes = value.GetType().GetField(value.ToString()).GetCustomAttributes(typeof(DescriptionAttribute), false);
    if (attributes.Any())
      return (attributes.First() as DescriptionAttribute).Description;

    // If no description is found, the least we can do is replace underscores with spaces
    // You can add your own custom default formatting logic here
    TextInfo ti = CultureInfo.CurrentCulture.TextInfo;
    return ti.ToTitleCase(ti.ToLower(value.ToString().Replace("_", " ")));
  }

  public static IEnumerable<ValueDescription> GetAllValuesAndDescriptions(Type t)
  {
    if (!t.IsEnum)
      throw new ArgumentException($"{nameof(t)} must be an enum type");

    return Enum.GetValues(t).Cast<Enum>().Select((e) => new ValueDescription() { Value = e, Description = e.Description() }).ToList();
  }
}

Далее мы создаем ValueConverter. Наследование от MarkupExtension упрощает использование в XAML, поэтому нам не нужно объявлять его как ресурс.

[ValueConversion(typeof(Enum), typeof(IEnumerable<ValueDescription>))]
public class EnumToCollectionConverter : MarkupExtension, IValueConverter
{
  public object Convert(object value, Type targetType, object parameter, CultureInfo culture)
  {
    return EnumHelper.GetAllValuesAndDescriptions(value.GetType());
  }
  public object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)
  {
    return null;
  }
  public override object ProvideValue(IServiceProvider serviceProvider)
  {
    return this;
  }
}

Моему ViewModel нужно только 1 свойство, с которым View может связываться как для SelectedValue, так и ItemsSource в выпадающем списке:

private PlayerClass playerClass;

public PlayerClass SelectedClass
{
  get { return playerClass; }
  set
  {
    if (playerClass != value)
    {
      playerClass = value;
      OnPropertyChanged(nameof(SelectedClass));
    }
  }
}

И, наконец, связать представление ComboBox (используя ValueConverter в привязке ItemsSource) ...

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

Для реализации этого решения вам нужно только скопировать мой класс EnumHelper и класс EnumToCollectionConverter. Они будут работать с любыми перечислениями. Кроме того, я не включил его здесь, но класс ValueDescription - это простой класс с 2 открытыми свойствами объекта, один из которых называется Value, другой - Description. Вы можете создать это самостоятельно или изменить код для использования Tuple<object, object> или KeyValuePair<object, object>

44 голосов
/ 01 июля 2013

Я использовал другое решение, используя MarkupExtension.

  1. Я создал класс, который обеспечивает источник элементов:

    public class EnumToItemsSource : MarkupExtension
    {
        private readonly Type _type;
    
        public EnumToItemsSource(Type type)
        {
            _type = type;
        }
    
        public override object ProvideValue(IServiceProvider serviceProvider)
        {
            return Enum.GetValues(_type)
                .Cast<object>()
                .Select(e => new { Value = (int)e, DisplayName = e.ToString() });
        }
    }
    
  2. Это почти всеТеперь используйте его в XAML:

        <ComboBox DisplayMemberPath="DisplayName"
              ItemsSource="{persons:EnumToItemsSource {x:Type enums:States}}"
              SelectedValue="{Binding Path=WhereEverYouWant}"
              SelectedValuePath="Value" />
    
  3. Замените 'enums: States' на ваше перечисление

20 голосов
/ 27 января 2015

Использовать 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}}"

на основании этой статьи

9 голосов
/ 30 мая 2013

Ответ Ника действительно помог мне, но я понял, что его можно немного подправить, чтобы избежать дополнительного класса ValueDescription. Я вспомнил, что в рамках фреймворка уже существует класс KeyValuePair, поэтому его можно использовать вместо этого.

Код изменяется незначительно:

public static IEnumerable<KeyValuePair<string, string>> GetAllValuesAndDescriptions<TEnum>() where TEnum : struct, IConvertible, IComparable, IFormattable
    {
        if (!typeof(TEnum).IsEnum)
        {
            throw new ArgumentException("TEnum must be an Enumeration type");
        }

        return from e in Enum.GetValues(typeof(TEnum)).Cast<Enum>()
               select new KeyValuePair<string, string>(e.ToString(),  e.Description());
    }


public IEnumerable<KeyValuePair<string, string>> PlayerClassList
{
   get
   {
       return EnumHelper.GetAllValuesAndDescriptions<PlayerClass>();
   }
}

и, наконец, XAML:

<ComboBox ItemSource="{Binding Path=PlayerClassList}"
          DisplayMemberPath="Value"
          SelectedValuePath="Key"
          SelectedValue="{Binding Path=SelectedClass}" />

Я надеюсь, что это полезно для других.

8 голосов
/ 27 мая 2011

Вам нужно создать массив значений в перечислении, который можно создать, вызвав System.Enum.GetValues ​​() , передав ему Type требуемого перечисления предметы.

Если вы укажете это для свойства ItemsSource, то оно должно быть заполнено всеми значениями перечисления. Возможно, вы захотите связать SelectedItem с EffectStyle (при условии, что это свойство того же перечисления и содержит текущее значение).

4 голосов
/ 17 сентября 2013

Все вышеперечисленные посты пропустили простой трюк.Из привязки SelectedValue можно узнать, как АВТОМАТИЧЕСКИ заполнить ItemsSource, чтобы ваша разметка XAML была просто.

<Controls:EnumComboBox SelectedValue="{Binding Fool}"/>

Например, в моей ViewModel у меня есть

public enum FoolEnum
    {
        AAA, BBB, CCC, DDD

    };


    FoolEnum _Fool;
    public FoolEnum Fool
    {
        get { return _Fool; }
        set { ValidateRaiseAndSetIfChanged(ref _Fool, value); }
    }

ValidateRaiseAndSetIfChanged - моя ловушка INPC.Ваш может отличаться.

Реализация EnumComboBox выглядит следующим образом, но сначала мне понадобится небольшой помощник для получения строк и значений моего перечисления

    public static List<Tuple<object, string, int>> EnumToList(Type t)
    {
        return Enum
            .GetValues(t)
            .Cast<object>()
            .Select(x=>Tuple.Create(x, x.ToString(), (int)x))
            .ToList();
    }

и основного класса (обратите внимание, я использую ReactiveUI дляперехват изменений свойств через WhenAny)

using ReactiveUI;
using ReactiveUI.Utils;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Reactive.Linq;
using System.Windows;
using System.Windows.Documents;

namespace My.Controls
{
    public class EnumComboBox : System.Windows.Controls.ComboBox
    {
        static EnumComboBox()
        {
            DefaultStyleKeyProperty.OverrideMetadata(typeof(EnumComboBox), new FrameworkPropertyMetadata(typeof(EnumComboBox)));
        }

        protected override void OnInitialized( EventArgs e )
        {
            base.OnInitialized(e);

            this.WhenAnyValue(p => p.SelectedValue)
                .Where(p => p != null)
                .Select(o => o.GetType())
                .Where(t => t.IsEnum)
                .DistinctUntilChanged()
                .ObserveOn(RxApp.MainThreadScheduler)
                .Subscribe(FillItems);
        }

        private void FillItems(Type enumType)
        {
            List<KeyValuePair<object, string>> values = new List<KeyValuePair<object,string>>();

            foreach (var idx in EnumUtils.EnumToList(enumType))
            {
                values.Add(new KeyValuePair<object, string>(idx.Item1, idx.Item2));
            }

            this.ItemsSource = values.Select(o=>o.Key.ToString()).ToList();

            UpdateLayout();
            this.ItemsSource = values;
            this.DisplayMemberPath = "Value";
            this.SelectedValuePath = "Key";

        }
    }
}

Вам также нужно правильно установить стиль в Generic.XAML, иначе ваш ящик не будет ничего визуализировать, и вы выдернете свои волосы.

<Style TargetType="{x:Type local:EnumComboBox}" BasedOn="{StaticResource {x:Type ComboBox}}">
</Style>

и это все.Это, очевидно, может быть расширено для поддержки i18n, но сделает этот пост длиннее.

2 голосов
/ 28 июля 2018

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

Учитывая перечисление ...

public enum ImageFormat
{
    [Description("Windows Bitmap")]
    BMP,
    [Description("Graphics Interchange Format")]
    GIF,
    [Description("Joint Photographic Experts Group Format")]
    JPG,
    [Description("Portable Network Graphics Format")]
    PNG,
    [Description("Tagged Image Format")]
    TIFF,
    [Description("Windows Media Photo Format")]
    WDP
}

и преобразователь значения ...

public class ImageFormatValueConverter : IValueConverter
{
    public object Convert(object value, Type targetType, object parameter, CultureInfo culture)
    {
        if (value is ImageFormat format)
        {
            return GetString(format);
        }

        return null;
    }

    public object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)
    {
        if (value is string s)
        {
            return Enum.Parse(typeof(ImageFormat), s.Substring(0, s.IndexOf(':')));
        }
        return null;
    }

    public string[] Strings => GetStrings();

    public static string GetString(ImageFormat format)
    {
        return format.ToString() + ": " + GetDescription(format);
    }

    public static string GetDescription(ImageFormat format)
    {
        return format.GetType().GetMember(format.ToString())[0].GetCustomAttribute<DescriptionAttribute>().Description;

    }
    public static string[] GetStrings()
    {
        List<string> list = new List<string>();
        foreach (ImageFormat format in Enum.GetValues(typeof(ImageFormat)))
        {
            list.Add(GetString(format));
        }

        return list.ToArray();
    }
}

ресурсы ...

    <local:ImageFormatValueConverter x:Key="ImageFormatValueConverter"/>

XAML декларация ...

    <ComboBox Grid.Row="9" ItemsSource="{Binding Source={StaticResource ImageFormatValueConverter}, Path=Strings}"
              SelectedItem="{Binding Format, Converter={StaticResource ImageFormatValueConverter}}"/>

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

    private ImageFormat _imageFormat = ImageFormat.JPG;
    public ImageFormat Format
    {
        get => _imageFormat;
        set
        {
            if (_imageFormat != value)
            {
                _imageFormat = value;
                OnPropertyChanged();
            }
        }
    }

Результирующий комбобокс ...

ComboBox bound to enum

2 голосов
/ 26 января 2016

Универсальные приложения работают немного по-другому;он не обладает всей мощью полнофункционального XAML.Что сработало для меня:

  1. Я создал список значений перечисления в виде перечислений (не преобразованных в строки или в целые числа) и привязал ComboBox ItemsSource к этому
  2. Затем ямог привязать ComboBox ItemSelected к моему общедоступному свойству, типом которого является рассматриваемый enum

Просто для забавы я подобрал небольшой шаблонный класс, чтобы помочь с этим, и опубликовал его на страницах MSDN Samples.Дополнительные биты позволяют мне при желании переопределять имена перечислений и позволяют скрывать некоторые перечисления.Мой код ужасно похож на код Ника (выше), который я хотел бы видеть раньше.

Running the sample; it includes multiple twoway bindings to the enum

2 голосов
/ 08 ноября 2014
public class EnumItemsConverter : IValueConverter
{
    public object Convert(object value, Type targetType, object parameter, CultureInfo culture)
    {
        if (!value.GetType().IsEnum)
            return false;

        var enumName = value.GetType();
        var obj = Enum.Parse(enumName, value.ToString());

        return System.Convert.ToInt32(obj);
    }

    public object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)
    {
        return Enum.ToObject(targetType, System.Convert.ToInt32(value));
    }
}

Вы должны расширить ответ Роджерса и Грега с помощью такого рода конвертера значений Enum, если вы привязываетесь напрямую к свойствам объектной модели enum.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...