Databinding คุณสมบัติ enum เป็น ComboBox ใน WPF

เป็นตัวอย่างใช้รหัสต่อไปนี้:

public enum ExampleEnum { FooBar, BarFoo }

public class ExampleClass : INotifyPropertyChanged
{
    private ExampleEnum example;

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

ฉันต้องการที่จะ databind คุณสมบัติ 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>

สิ่งนี้ฉันสามารถใช้เป็นแหล่งรายการสำหรับ 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 ใน UI ฉันชอบใช้ค่าที่แตกต่างสำหรับผู้ใช้ (DisplayMemberPath ) และต่างกันสำหรับค่า (enum ในกรณีนี้) ( SelectedValuePath) ค่าทั้งสองนั้นสามารถบรรจุได้KeyValuePairและเก็บไว้ในพจนานุกรมได้

XAML

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

ค#

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-only แต่ลองทำสิ่งต่อไปนี้:

ตั้งชื่อ ComboBox ของคุณเพื่อให้คุณสามารถเข้าถึงได้ใน codebehind: "typesComboBox1"

ลองทำสิ่งต่อไปนี้

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

อิงตามคำตอบที่ยอมรับ แต่ถูกลบแล้วในขณะนี้โดยageektrappedฉันได้สร้างเวอร์ชันที่บางลงโดยไม่ต้องใช้คุณสมบัติขั้นสูง รหัสทั้งหมดรวมอยู่ที่นี่เพื่ออนุญาตให้คุณคัดลอกวางและไม่ถูกบล็อกโดย link-rot

ฉันใช้สิ่งSystem.ComponentModel.DescriptionAttributeที่มีไว้สำหรับคำอธิบายเวลาการออกแบบจริงๆ หากคุณไม่ชอบการใช้คุณสมบัตินี้คุณอาจสร้างของคุณเอง แต่ฉันคิดว่าการใช้คุณสมบัตินี้จะทำให้งานสำเร็จ หากคุณไม่ใช้แอททริบิวชื่อจะใช้ชื่อของค่า enum เป็นรหัส

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;
  }
}

ตัวแปลงนี้จะทำงานกับ enum ใด ๆ ValueDescriptionเป็นเพียงคลาสที่เรียบง่ายพร้อมด้วยValueคุณสมบัติและDescriptionคุณสมบัติ คุณสามารถใช้Tuplewith Item1and Item2หรือ a KeyValuePairด้วยKeyและValueแทนที่จะเป็น Value and Description หรือคลาสอื่น ๆ ที่คุณเลือกตราบเท่าที่มันสามารถเก็บค่า enum และคำอธิบายสตริงของค่า enum นั้นได้

นี่คือโซลูชันทั่วไปโดยใช้วิธีการช่วยเหลือ นอกจากนี้ยังสามารถจัดการ enum ของประเภทพื้นฐานใด ๆ (ไบต์, sbyte, uint, ยาว ฯลฯ )

วิธีช่วยเหลือ:

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:

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

คุณสามารถพิจารณาบางสิ่งเช่นนั้น:

1. กำหนดสไตล์สำหรับ textblock หรือส่วนควบคุมอื่น ๆ ที่คุณต้องการใช้เพื่อแสดง enum ของคุณ:

   <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 และโหลดด้วยค่า enum ของคุณ:

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

หาก enum ของคุณมีขนาดใหญ่แน่นอนคุณสามารถทำเช่นเดียวกันในรหัสประหยัดมากพิมพ์ ฉันชอบวิธีการนี้เนื่องจากทำให้การโลคัลไลซ์เซชันง่ายขึ้น - คุณกำหนดเทมเพลตทั้งหมดเพียงครั้งเดียวจากนั้นคุณอัปเดตไฟล์ทรัพยากรสตริงของคุณเท่านั้น

หากคุณใช้ MVVM อยู่บนพื้นฐานของ @rudigrobler answer คุณสามารถทำสิ่งต่อไปนี้:

เพิ่มคุณสมบัติต่อไปนี้ไปยังคลาสViewModel

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

จากนั้นใน XAML ให้ทำดังนี้:

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

นี่คือDevExpressคำตอบเฉพาะตามคำตอบที่ได้รับการโหวตโดยGregor S. (ปัจจุบันมี 128 คะแนน)

ซึ่งหมายความว่าเราสามารถรักษาสไตล์ที่สอดคล้องกันตลอดทั้งแอปพลิเคชัน:

น่าเสียดายที่คำตอบดั้งเดิมนั้นใช้ไม่ได้กับComboBoxEditDevExpress โดยไม่มีการดัดแปลงใด ๆ

ก่อนอื่น 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ที่เนมสเปซที่มี Enum:

xmlns:myEnum="clr-namespace:MyNamespace"

จากนั้น Enum:

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}" />