如何将枚举绑定到WPF中的组合框控件?

你需要在枚举中创建一个值数组，它可以通过调用System.Enum.GetValues ()来创建，将你想要的枚举的Type传递给它。

如果你为ItemsSource属性指定了这个，那么它应该被枚举的所有值填充。你可能想将SelectedItem绑定到EffectStyle(假设它是同一个枚举的属性，并且包含当前值)。

你可以通过在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上读取的命名空间和程序集。

我喜欢我绑定的所有对象都定义在我的ViewModel中，所以我尽量避免在xaml中使用<ObjectDataProvider>。

我的解决方案不使用视图中定义的数据，也不使用隐藏代码。只有一个DataBinding，一个可重用的ValueConverter，一个用于获取任意Enum类型的描述集合的方法，以及ViewModel中要绑定的单个属性。

当我想将一个Enum绑定到一个ComboBox时，我想显示的文本永远不匹配Enum的值，所以我使用[Description()]属性给它我实际上想在ComboBox中看到的文本。如果我有一周中的一天，它看起来会像这样:

public enum DayOfWeek
{
// add an optional blank value for default/no selection
[Description("")]
NOT_SET = 0,
[Description("Sunday")]
SUNDAY,
[Description("Monday")]
MONDAY,
...
}

首先，我创建了一个helper类，其中包含几个处理枚举的方法。一个方法获取一个特定值的描述，另一个方法获取一个类型的所有值及其描述。

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只需要一个属性，我的View可以绑定到组合框的SelectedValue和ItemsSource:

private DayOfWeek dayOfWeek;


public DayOfWeek SelectedDay
{
get { return dayOfWeek; }
set
{
if (dayOfWeek != value)
{
dayOfWeek = value;
OnPropertyChanged(nameof(SelectedDay));
}
}
}

最后绑定ComboBox视图(在ItemsSource绑定中使用ValueConverter)…

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

要实现这个解决方案，你只需要复制我的EnumHelper类和EnumToCollectionConverter类。它们将与任何枚举一起工作。而且，我在这里没有包括它，但ValueDescription类只是一个简单的类，具有两个公共对象属性，一个叫Value，一个叫Description。你可以自己创建，也可以修改代码使用Tuple<object, object>或KeyValuePair<object, object>

尼克的回答是真的帮助了我，但我意识到它可以稍微调整，以避免一个额外的类，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}" />

我希望这对其他人有所帮助。

我使用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. That's almost all... Now use it in XAML:

       <ComboBox DisplayMemberPath="DisplayName"
   ItemsSource="{persons:EnumToItemsSource {x:Type enums:States}}"
   SelectedValue="{Binding Path=WhereEverYouWant}"
   SelectedValuePath="Value" />
   

3. Change 'enums:States' to your enum

如果你绑定到ViewModel上的实际枚举属性，而不是枚举的int表示，事情就变得棘手了。我发现有必要绑定到字符串表示，而不是在上述所有示例中预期的int值。

您可以通过将一个简单的文本框绑定到ViewModel上想要绑定的属性来判断是否存在这种情况。如果显示文本，则绑定到字符串。如果它显示一个数字，则绑定到该值。注意，我已经使用了两次显示，这通常是一个错误，但这是它工作的唯一方式。

<ComboBox SelectedValue="{Binding ElementMap.EdiDataType, Mode=TwoWay}"
DisplayMemberPath="Display"
SelectedValuePath="Display"
ItemsSource="{Binding Source={core:EnumToItemsSource {x:Type edi:EdiDataType}}}" />

格雷格

上面所有的帖子都忽略了一个简单的技巧。可以从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，但会使帖子更长。

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值转换器扩展Rogers和Greg的回答。

使用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}}"

基于这篇文章

通用应用程序的工作方式似乎有点不同;它不具备全功能XAML的所有功能。对我有用的是:

1. 我创建了一个枚举值列表作为enum(未转换为 字符串或整数)，并将ComboBox ItemsSource绑定到
然后我可以将ComboBox ItemSelected绑定到我的公共属性 问题中的枚举是谁的类型

只是为了好玩，我创建了一个小模板类来帮助解决这个问题，并将它发布到MSDN样本页面。额外的位可以让我有选择地覆盖枚举的名称，并让我隐藏一些枚举。我的代码看起来很像Nick的(上面)，我希望我能早点看到。

<ComboBox SelectedValue="{Binding MyEnumProperty}"
SelectedValuePath="Value"
ItemsSource="{local:EnumToObjectArray SourceEnum={Binding MyEnumProperty}}"
DisplayMemberPath="DisplayName" />

class EnumToObjectArray : MarkupExtension
{
public BindingBase SourceEnum { get; set; }


public override object ProvideValue(IServiceProvider serviceProvider)
{
IProvideValueTarget target = serviceProvider.GetService(typeof(IProvideValueTarget)) as IProvideValueTarget;
DependencyObject targetObject;
DependencyProperty targetProperty;


if (target != null && target.TargetObject is DependencyObject && target.TargetProperty is DependencyProperty)
{
targetObject = (DependencyObject)target.TargetObject;
targetProperty = (DependencyProperty)target.TargetProperty;
}
else
{
return this;
}


BindingOperations.SetBinding(targetObject, EnumToObjectArray.SourceEnumBindingSinkProperty, SourceEnum);


var type = targetObject.GetValue(SourceEnumBindingSinkProperty).GetType();


if (type.BaseType != typeof(System.Enum)) return this;


return Enum.GetValues(type)
.Cast<Enum>()
.Select(e => new { Value=e, Name = e.ToString(), DisplayName = Description(e) });
}


private static DependencyProperty SourceEnumBindingSinkProperty = DependencyProperty.RegisterAttached("SourceEnumBindingSink", typeof(Enum)
, typeof(EnumToObjectArray), new FrameworkPropertyMetadata(null, FrameworkPropertyMetadataOptions.Inherits));


/// <summary>
/// Extension method which returns the string specified in the Description attribute, if any.  Oherwise, name is returned.
/// </summary>
/// <param name="value">The enum value.</param>
/// <returns></returns>
public static string Description(Enum value)
{
var attrs = value.GetType().GetField(value.ToString()).GetCustomAttributes(typeof(DescriptionAttribute), false);
if (attrs.Any())
return (attrs.First() as DescriptionAttribute).Description;


//Fallback
return value.ToString().Replace("_", " ");
}
}