enumプロパティをWPFのComboBoxにデータバインドする


256

例として、次のコードを見てください。

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を使い始めたくありません。

編集する

したがって、1つの質問に答えました。ComboBoxに適切な値を設定するにはどうすればよいですか。

静的なEnum.GetValuesメソッドからObjectDataProviderを介してEnum値を文字列のリストとして取得します。

<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のItemsSourceとして使用できます。

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

4
私はこれを調査し、ここにあるWPFで(ローカライズを完了して)使用できるソリューションを用意しました
ageektrapped 2008

回答:


208

カスタムマークアップ拡張機能を作成できます。

使用例:

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

7
@Gregor S. my:Enumerationは何ですか?
joshua

14
@Crown 'my'は、xamlファイルの上部で宣言する名前空間接頭辞です。例:xmlns:my = "clr-namespace:namespace_to_enumeration_extension_class。列挙はEnumerationExtensionの略であり、xamlでは拡張クラス名全体を記述する必要はありません。 。
グレゴールSlavec

33
+1ですが、WPFが単純なものを実現するために必要なコードの量は本当に頭を悩ませています
Konrad Morawski

1
ビューのItemsSourceparam で、モデルの一部への参照(列挙型)を使用する方法があまり好きではありません。ビューとモデルを分離した状態に保つために、ViewModelとコードViewModelに列挙のコピーを作成して、2つの間を変換する必要があります。これにより、ソリューションはそれほど単純ではなくなります。または、ViewModelから型自体を提供する方法はありますか?
ランパック2012

6
別の制限は、複数の言語がある場合、これを行うことができないことです。
River-Claire Williamson

176

ビューモデルでは、次のことが可能です。

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>

これは私のユニバーサルアプリで素晴らしく機能し、実装は非常に簡単でした。ありがとうございました!
Nathan Strutz、2017年

96

UIで列挙型の名前を使用したくない。ユーザー(DisplayMemberPath)と値(この場合は列挙型)(SelectedValuePath)に異なる値を使用することをお勧めします。これら2つの値は、パックし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パターンと互換性があります。


14
私はあなたの答えは過小評価されていると思います、それはComboBox自体が期待することを考えると最良のオプションのようです。おそらく、を使用して辞書ビルダーをゲッターに配置できますがEnum.GetValues、これでは表示される名前の部分が解決されません。結局のところ、特にI18nが実装されている場合は、列挙型が変更された場合に手動で変更する必要があります。しかし、列挙型は頻繁に変更されるとは限りません。+1
Heltonbiker 2013年

2
この答えは素晴らしいです、そしてそれは列挙型の説明をローカライズすることを可能にします...これをありがとう!
シェイ

2
このソリューションは、列挙型とローカライズの両方を処理するため、他のソリューションよりも少ないコードで非常に優れています。
hfann 2017年

2
ディクショナリの問題は、キーがハッシュ値によって順序付けられるため、その制御がほとんどできないことです。もう少し冗長ですが、代わりにList <KeyValuePair <enum、string >>を使用しました。良いアイデア。
ケビンブロック

3
@CoperNick @Pragmateekの新しい修正:public Dictionary<ExampleEnum, string> ExampleEnumsWithCaptions { get; } = new Dictionary<ExampleEnum, string>() { {ExampleEnum.FooBar, "Foo Bar"}, {ExampleEnum.BarFoo, "Reversed Foo Bar"}, //{ExampleEnum.None, "Hidden in UI"}, };
Jinjinov

40

XAMLのみで可能かどうかはわかりませんが、次のことを試してください。

コードビハインドでアクセスできるように、ComboBoxに名前を付けます: "typesComboBox1"

次を試してください

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

24

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

23

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

このブログでこの解決策を見つけてください


素敵な答え。ちなみに、Converter列挙型から文字列への問題でaを心配する必要はありません。
DonBoitnott 2017年

1
リンクされたソリューションは死んでいるようです(韓国語または日本語のテキスト?)。私のコードをXAMLリソースに配置すると、EnumはWPFプロジェクトでサポートされていないと表示されます。
セバスチャン

6

これを行う私のお気に入りの方法は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持つ単純なクラスです。あなたは同じように簡単に使用することができますとして、またはを持つとその列挙値の列挙値と文字列の説明を保持することができ、長いそれが持っているとしてとして代わりの値と説明またはお好みの他のクラス。ValueDescriptionTupleItem1Item2KeyValuePairKeyValue


素敵な答え!以下のためにValueDescriptionクラス、Description必要でない場合、このプロパティを省略することができます。Valueプロパティのみの単純なクラスも機能します!
pogosama 2017年

また、RadioButtonにバインドする場合、Convertメソッドは.Select(e => e.ToString())ValueDescriptionクラスを使用する代わりに、文字列のリストを返す必要があります。
pogosama 2017年

ここに示すように、代わりにを使用ValueDescriptionするKeyValuePairこともできます
Apfelkuacha

5

ヘルパーメソッドを使用した一般的なソリューションを次に示します。これは、基礎となる任意の型(バイト、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"
/>

5

あなたはそのようなものを考えることができます:

  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>

enumが大きい場合は、もちろんコードで同じことを行うことができ、多くの入力を省略できます。ローカリゼーションを簡単にするので、私はそのアプローチが好きです-すべてのテンプレートを一度定義すると、文字列リソースファイルを更新するだけです。


SelectedValuePath = "Content"はここで私を助けました。ComboBoxItemsを文字列値として持っていますが、ComboBoxItemをEnum Typeに変換できません。ありがとう
adriaanp 2009年

2

MVVMを使用している場合、@ rudigroblerの回答に基づいて、次の操作を実行できます。

次のプロパティをViewModelクラスに追加します。

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

次に、XAMLで以下を実行します。

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

1

これは、(現在128票)DevExpressによるトップ投票の回答に基づく特定の回答ですGregor S.

つまり、アプリケーション全体でスタイルの一貫性を保つことができます。

ここに画像の説明を入力してください

残念ながら、元の答えは、ComboBoxEditいくつかの変更なしではDevExpressのaでは機能しません。

最初に、の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も素晴らしいライブラリです。


念のため、私はDevExpressとは提携していません。Telerikには非常に細かいライブラリーもあり、この手法はライブラリーにさえ必要ない場合があります。
Contango 2015年

0

使ってみてください

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

これは機能しません。コンボボックスは空のテキストを表示するだけで、変更しても何も起こりません。ここでコンバータを投入するのが最善の解決策だと思います。
Maximilian

0

これを行うオープンソースのCodePlexプロジェクトを作成しました。ここからNuGetパッケージをダウンロードできます。

<enumComboBox:EnumComboBox EnumType="{x:Type demoApplication:Status}" SelectedValue="{Binding Status}" />
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.