EnumをASP.NETのDropDownListコントロールにバインドするにはどうすればよいですか？

126

次の簡単な列挙型があるとしましょう：

enum Response
{
    Yes = 1,
    No = 2,
    Maybe = 3
}

この列挙型をDropDownListコントロールにバインドして、説明がリストに表示され、オプションが選択されたら関連する数値（1、2、3）を取得する方法を教えてください。

c#  .net  asp.net 
— レイ
ソース

回答:

112

データは列挙型であるため、おそらくバインドしません。また、コンパイル時に変更されません（これらの愚かな瞬間がない限り）。

列挙型を反復するだけの方が良い： 

Dim itemValues As Array = System.Enum.GetValues(GetType(Response))
Dim itemNames As Array = System.Enum.GetNames(GetType(Response))

For i As Integer = 0 To itemNames.Length - 1
    Dim item As New ListItem(itemNames(i), itemValues(i))
    dropdownlist.Items.Add(item)
Next

またはC＃でも同じ 

Array itemValues = System.Enum.GetValues(typeof(Response));
Array itemNames = System.Enum.GetNames(typeof(Response));

for (int i = 0; i <= itemNames.Length - 1 ; i++) {
    ListItem item = new ListItem(itemNames[i], itemValues[i]);
    dropdownlist.Items.Add(item);
}
— マーク・グローリー
ソース
1
この回答をどうもありがとう。EnumクラスではなくEnumのインスタンスを受け取ったため、GetType（Response）は機能しませんでした。したがって、代わりにenumInstance.GetType（）を使用します。
— セバスチャン
2
getValuesとgetNamesの両方が同じように返すため、C＃を使用しても機能しません。列挙型の定義は次のとおりです。public enum eResult {Right = 1、
— Non統制エラー
9
ちなみに、C＃では、インデックスitemNames [i]を使用して配列にアクセスすることはできません。arrayObject.GetValue（i）を使用してのみアクセスでき、どちらの場合も名前だけを返します。
— Javiere 2013年
1
このソリューションをこの1つのstackoverflow.com/questions/3213432/…
— Javiere
5
なぜこれは非常に多くの賛成票を持っているのですか？コード（少なくともc＃）は機能し、構文エラーが含まれています。
— Dave
69

Enumerationから（Enum値と名前のペア）Enumerationを取得するには、次のユーティリティクラスを使用します。次に、IDictionaryをバインド可能なコントロールにバインドします。IDictionary<int,string>

public static class Enumeration
{
    public static IDictionary<int, string> GetAll<TEnum>() where TEnum: struct
    {
        var enumerationType = typeof (TEnum);

        if (!enumerationType.IsEnum)
            throw new ArgumentException("Enumeration type is expected.");

        var dictionary = new Dictionary<int, string>();

        foreach (int value in Enum.GetValues(enumerationType))
        {
            var name = Enum.GetName(enumerationType, value);
            dictionary.Add(value, name);
        }

        return dictionary;
    }
}

例：ユーティリティクラスを使用して列挙データをコントロールにバインドする

ddlResponse.DataSource = Enumeration.GetAll<Response>();
ddlResponse.DataTextField = "Value";
ddlResponse.DataValueField = "Key";
ddlResponse.DataBind();
— レイ
ソース
1
+1。私はそれを使用しましたが、キーと値は間違った方法だと思います。これはIDictionary <string、int>を返すはずです
— Colin
これは、すべての列挙型（uint、ulong、longなど）で正しく動作しないことに注意してください。通常、検索するのに最も効率的なフィールドはキーです。この場合、整数は単純な<​​、=、>比較であり、各文字に対する文字列の<および>比較であるため、これはintになります。
— Trisped
43

これをASP.NET MVCに使用します。

Html.DropDownListFor(o => o.EnumProperty, Enum.GetValues(typeof(enumtype)).Cast<enumtype>().Select(x => new SelectListItem { Text = x.ToString(), Value = ((int)x).ToString() }))
— フェリット
ソース
36

私のバージョンは上記の圧縮形式です：

foreach (Response r in Enum.GetValues(typeof(Response)))
{
    ListItem item = new ListItem(Enum.GetName(typeof(Response), r), r.ToString());
    DropDownList1.Items.Add(item);
}
— ヴァンオーマン
ソース
4
（int r in Enum.GetValues（typeof（Response）））である必要があります。そうでない場合は、説明を名前と値としてバインドします...
— Evan
2
ListItemの値に列挙型メンバーの名前を挿入するため、これは機能しません。ほとんどの場合intへの変換は機能しますが、列挙型がuint、ulong、またはlongの場合は機能しません。
— Trisped 2012年
はるかに良いソリューション私見。
— Vippy
23 
public enum Color
{
    RED,
    GREEN,
    BLUE
}

すべての列挙型はSystem.Enumから派生します。ドロップダウンリストコントロールへのデータのバインド（および値の取得）に役立つ2つの静的メソッドがあります。これらはEnum.GetNamesとEnum.Parseです。GetNamesを使用すると、次のようにドロップダウンリストコントロールにバインドできます。

protected System.Web.UI.WebControls.DropDownList ddColor;

private void Page_Load(object sender, System.EventArgs e)
{
     if(!IsPostBack)
     {
        ddColor.DataSource = Enum.GetNames(typeof(Color));
        ddColor.DataBind();
     }
}

Enumの値を選択に戻す場合は、次のようにします。

  private void ddColor_SelectedIndexChanged(object sender, System.EventArgs e)
  {
    Color selectedColor = (Color)Enum.Parse(typeof(Color),ddColor.SelectedValue
  }
— キャンベル
ソース
2
良い答えですが、少しヒント：Color selectedColor =（Color）Enum.Parse（typeof（Color）、ddColor.SelectedValue）;
— sma6871 2015年
11

すべての投稿を読んだ後、ドロップダウンリストに列挙型の説明を表示し、編集モードで表示するときにドロップダウンのモデルから適切な値を選択することをサポートする包括的なソリューションを思い付きました：

列挙型：

using System.ComponentModel;
public enum CompanyType
{
    [Description("")]
    Null = 1,

    [Description("Supplier")]
    Supplier = 2,

    [Description("Customer")]
    Customer = 3
}

列挙型拡張クラス：

using System.Collections.Generic;
using System.ComponentModel;
using System.Linq;
using System.Web.Mvc;

public static class EnumExtension
{
    public static string ToDescription(this System.Enum value)
    {
        var attributes = (DescriptionAttribute[])value.GetType().GetField(value.ToString()).GetCustomAttributes(typeof(DescriptionAttribute), false);
        return attributes.Length > 0 ? attributes[0].Description : value.ToString();
    }

    public static IEnumerable<SelectListItem> ToSelectList<T>(this System.Enum enumValue)
    {
        return
            System.Enum.GetValues(enumValue.GetType()).Cast<T>()
                  .Select(
                      x =>
                      new SelectListItem
                          {
                              Text = ((System.Enum)(object) x).ToDescription(),
                              Value = x.ToString(),
                              Selected = (enumValue.Equals(x))
                          });
    }
}

モデルクラス：

public class Company
{
    public string CompanyName { get; set; }
    public CompanyType Type { get; set; }
}

と表示：

@Html.DropDownListFor(m => m.Type,
@Model.Type.ToSelectList<CompanyType>())

モデルにバインドせずにドロップダウンを使用している場合は、代わりにこれを使用できます。

@Html.DropDownList("type",                  
Enum.GetValues(typeof(CompanyType)).Cast<CompanyType>()
.Select(x => new SelectListItem {Text = x.ToDescription(), Value = x.ToString()}))

こうすることで、ドロップダウンに列挙値ではなく説明が表示されることが期待できます。また、編集に関しては、ページを投稿した後、選択した値をドロップダウンしてモデルを更新します。

— アミール・チャトルバー
ソース
1
特に[Description]アノテーションのビットがうまくいきました。この手法を採用します。
— バクスター2015
きちんとした説明。賞賛アミール!!
8

他の人がすでに言ったように-状況に応じて異なる列挙型にバインドする必要がない限り、列挙型にデータバインドしないでください。これにはいくつかの方法があります。以下に例をいくつか示します。

ObjectDataSource

ObjectDataSourceでそれを行う宣言的な方法。まず、DropDownListをバインドするリストを返すBusinessObjectクラスを作成します。

public class DropDownData
{
    enum Responses { Yes = 1, No = 2, Maybe = 3 }

    public String Text { get; set; }
    public int Value { get; set; }

    public List<DropDownData> GetList()
    {
        var items = new List<DropDownData>();
        foreach (int value in Enum.GetValues(typeof(Responses)))
        {
            items.Add(new DropDownData
                          {
                              Text = Enum.GetName(typeof (Responses), value),
                              Value = value
                          });
        }
        return items;
    }
}

次に、このBOクラスを指すようにASPXページにHTMLマークアップを追加します。

<asp:DropDownList ID="DropDownList1" runat="server" 
    DataSourceID="ObjectDataSource1" DataTextField="Text" DataValueField="Value">
</asp:DropDownList>
<asp:ObjectDataSource ID="ObjectDataSource1" runat="server" 
    SelectMethod="GetList" TypeName="DropDownData"></asp:ObjectDataSource>

このオプションではコードビハインドは必要ありません。

DataBindの背後にあるコード

ASPXページのHTMLを最小化し、コードビハインドでバインドするには：

enum Responses { Yes = 1, No = 2, Maybe = 3 }

protected void Page_Load(object sender, EventArgs e)
{
    if (!IsPostBack)
    {
        foreach (int value in Enum.GetValues(typeof(Responses)))
        {
            DropDownList1.Items.Add(new ListItem(Enum.GetName(typeof(Responses), value), value.ToString()));
        }
    }
}

とにかく、コツはGetValuesやGetNamesなどのEnum型のメソッドを機能させることです。

— ヨハン・ダンフォース
ソース
6

ASP.NETでそれを行う方法はわかりませんが、この投稿を確認してください...役立つかもしれません。

Enum.GetValues(typeof(Response));
— Rudigrobler
ソース
6

あなたはlinqを使うことができます：

var responseTypes= Enum.GetNames(typeof(Response)).Select(x => new { text = x, value = (int)Enum.Parse(typeof(Response), x) });
    DropDownList.DataSource = responseTypes;
    DropDownList.DataTextField = "text";
    DropDownList.DataValueField = "value";
    DropDownList.DataBind();
— クリシュナ
ソース
5 
Array itemValues = Enum.GetValues(typeof(TaskStatus));
Array itemNames = Enum.GetNames(typeof(TaskStatus));

for (int i = 0; i <= itemNames.Length; i++)
{
    ListItem item = new ListItem(itemNames.GetValue(i).ToString(),
    itemValues.GetValue(i).ToString());
    ddlStatus.Items.Add(item);
}
— ジョン・ウィレムセ
ソース
4 
public enum Color
{
    RED,
    GREEN,
    BLUE
}

ddColor.DataSource = Enum.GetNames(typeof(Color));
ddColor.DataBind();
— sankalp gurha
ソース
3

回答6を使用した汎用コード。

public static void BindControlToEnum(DataBoundControl ControlToBind, Type type)
{
    //ListControl

    if (type == null)
        throw new ArgumentNullException("type");
    else if (ControlToBind==null )
        throw new ArgumentNullException("ControlToBind");
    if (!type.IsEnum)
        throw new ArgumentException("Only enumeration type is expected.");

    Dictionary<int, string> pairs = new Dictionary<int, string>();

    foreach (int i in Enum.GetValues(type))
    {
        pairs.Add(i, Enum.GetName(type, i));
    }
    ControlToBind.DataSource = pairs;
    ListControl lstControl = ControlToBind as ListControl;
    if (lstControl != null)
    {
        lstControl.DataTextField = "Value";
        lstControl.DataValueField = "Key";
    }
    ControlToBind.DataBind();

}
— ムハンマドカシム
ソース
3

この答えを見つけた後、私はこれを行うためのより良い（少なくともよりエレガントな）方法であると思いました。ここに戻ってそれを共有すると思いました。

Page_Load：

DropDownList1.DataSource = Enum.GetValues(typeof(Response));
DropDownList1.DataBind();

LoadValues：

Response rIn = Response.Maybe;
DropDownList1.Text = rIn.ToString();

SaveValues：

Response rOut = (Response) Enum.Parse(typeof(Response), DropDownList1.Text);
— ベン・ヒューズ
ソース
2

これはおそらく古い質問です。しかし、これが私のやり方です。

モデル： 

public class YourEntity
{
   public int ID { get; set; }
   public string Name{ get; set; }
   public string Description { get; set; }
   public OptionType Types { get; set; }
}

public enum OptionType
{
    Unknown,
    Option1, 
    Option2,
    Option3
}

次に、ビューで：ドロップダウンを使用する方法を次に示します。

@Html.EnumDropDownListFor(model => model.Types, htmlAttributes: new { @class = "form-control" })

これにより、列挙リストのすべてが読み込まれます。お役に立てれば..

— マリーマクドンリー
ソース
ただし、これは機能しますが、スペースを含む文字列リテラルを組み込む場合は、拡張クラスが必要です。
1
これが最良の答えです。@Nikul、拡張クラスは必要ありません。注釈のみを使用する必要があります。 [Display(Name = "Option number one")] Option1,
— 応援19/07/19
1

このように使用して、すべてのlistControleを渡すことができるのはなぜですか。 


public static void BindToEnum(Type enumType, ListControl lc)
        {
            // get the names from the enumeration
            string[] names = Enum.GetNames(enumType);
            // get the values from the enumeration
            Array values = Enum.GetValues(enumType);
            // turn it into a hash table
            Hashtable ht = new Hashtable();
            for (int i = 0; i < names.Length; i++)
                // note the cast to integer here is important
                // otherwise we'll just get the enum string back again
                ht.Add(names[i], (int)values.GetValue(i));
            // return the dictionary to be bound to
            lc.DataSource = ht;
            lc.DataTextField = "Key";
            lc.DataValueField = "Value";
            lc.DataBind();
        }
使い方は次のように簡単です： 

BindToEnum(typeof(NewsType), DropDownList1);
BindToEnum(typeof(NewsType), CheckBoxList1);
BindToEnum(typeof(NewsType), RadoBuuttonList1);

— モスタファ
ソース
1

ASP.NETは、いくつかの機能が追加されて更新され、組み込みの列挙型を使用してドロップダウンできるようになりました。

Enum自体にバインドする場合は、次のようにします。

@Html.DropDownList("response", EnumHelper.GetSelectList(typeof(Response)))

Responseのインスタンスにバインドしている場合は、これを使用します。

// Assuming Model.Response is an instance of Response
@Html.EnumDropDownListFor(m => m.Response)
— bradlis7
ソース
0

これは、LINQを使用したOrder a EnumおよびDataBind（Text and Value）to Dropdownの私のソリューションです

var mylist = Enum.GetValues(typeof(MyEnum)).Cast<MyEnum>().ToList<MyEnum>().OrderBy(l => l.ToString());
foreach (MyEnum item in mylist)
    ddlDivisao.Items.Add(new ListItem(item.ToString(), ((int)item).ToString()));
— ディエゴメンデス
ソース
0

コンボボックス（または他のコントロール）でよりユーザーフレンドリーな説明を使用する場合は、次の関数でDescription属性を使用できます。

    public static object GetEnumDescriptions(Type enumType)
    {
        var list = new List<KeyValuePair<Enum, string>>();
        foreach (Enum value in Enum.GetValues(enumType))
        {
            string description = value.ToString();
            FieldInfo fieldInfo = value.GetType().GetField(description);
            var attribute = fieldInfo.GetCustomAttributes(typeof(DescriptionAttribute), false).First();
            if (attribute != null)
            {
                description = (attribute as DescriptionAttribute).Description;
            }
            list.Add(new KeyValuePair<Enum, string>(value, description));
        }
        return list;
    }

Description属性が適用された列挙型の例を次に示します。

    enum SampleEnum
    {
        NormalNoSpaces,
        [Description("Description With Spaces")]
        DescriptionWithSpaces,
        [Description("50%")]
        Percent_50,
    }

次に、バインドしてそのように制御します...

        m_Combo_Sample.DataSource = GetEnumDescriptions(typeof(SampleEnum));
        m_Combo_Sample.DisplayMember = "Value";
        m_Combo_Sample.ValueMember = "Key";

このようにして、変数名のように見えなくても、ドロップダウンに好きなテキストを置くことができます

— ジョシュ・ストライブリング
ソース
0

Extensionメソッドを使用することもできます。拡張機能に慣れていない場合は、VBおよびC＃のドキュメントを確認することをお勧めします。

VB拡張：

Namespace CustomExtensions
    Public Module ListItemCollectionExtension

        <Runtime.CompilerServices.Extension()> _
        Public Sub AddEnum(Of TEnum As Structure)(items As System.Web.UI.WebControls.ListItemCollection)
            Dim enumerationType As System.Type = GetType(TEnum)
            Dim enumUnderType As System.Type = System.Enum.GetUnderlyingType(enumType)

            If Not enumerationType.IsEnum Then Throw New ArgumentException("Enumeration type is expected.")

            Dim enumTypeNames() As String = System.Enum.GetNames(enumerationType)
            Dim enumTypeValues() As TEnum = System.Enum.GetValues(enumerationType)

            For i = 0 To enumTypeNames.Length - 1
                items.Add(New System.Web.UI.WebControls.ListItem(saveResponseTypeNames(i), TryCast(enumTypeValues(i), System.Enum).ToString("d")))
            Next
        End Sub
    End Module
End Namespace

拡張機能を使用するには：

Imports <projectName>.CustomExtensions.ListItemCollectionExtension

...

yourDropDownList.Items.AddEnum(Of EnumType)()

C＃拡張：

namespace CustomExtensions
{
    public static class ListItemCollectionExtension
    {
        public static void AddEnum<TEnum>(this System.Web.UI.WebControls.ListItemCollection items) where TEnum : struct
        {
            System.Type enumType = typeof(TEnum);
            System.Type enumUnderType = System.Enum.GetUnderlyingType(enumType);

            if (!enumType.IsEnum) throw new Exception("Enumeration type is expected.");

            string[] enumTypeNames = System.Enum.GetNames(enumType);
            TEnum[] enumTypeValues = (TEnum[])System.Enum.GetValues(enumType);

            for (int i = 0; i < enumTypeValues.Length; i++)
            {
                items.add(new System.Web.UI.WebControls.ListItem(enumTypeNames[i], (enumTypeValues[i] as System.Enum).ToString("d")));
            }
        }
    }
}

拡張機能を使用するには：

using CustomExtensions.ListItemCollectionExtension;

...

yourDropDownList.Items.AddEnum<EnumType>()

選択した項目を同時に設定したい場合は

items.Add(New System.Web.UI.WebControls.ListItem(saveResponseTypeNames(i), saveResponseTypeValues(i).ToString("d")))

と

Dim newListItem As System.Web.UI.WebControls.ListItem
newListItem = New System.Web.UI.WebControls.ListItem(enumTypeNames(i), Convert.ChangeType(enumTypeValues(i), enumUnderType).ToString())
newListItem.Selected = If(EqualityComparer(Of TEnum).Default.Equals(selected, saveResponseTypeValues(i)), True, False)
items.Add(newListItem)

むしろSystem.Enumに変換することで、intサイズと出力の問題が回避されます。たとえば、0xFFFF0000はuintとしては4294901760ですが、intとしては-65536になります。

TryCastおよびSystem.Enumは、Convert.ChangeType（enumTypeValues [i]、enumUnderType）.ToString（）（私の速度テストでは12:13）よりもわずかに高速です。

— Trisped
ソース
0

承認されたソリューションは機能しませんが、以下のコードは、最短のソリューションを探している他のユーザーを支援します。

 foreach (string value in Enum.GetNames(typeof(Response)))
                    ddlResponse.Items.Add(new ListItem()
                    {
                        Text = value,
                        Value = ((int)Enum.Parse(typeof(Response), value)).ToString()
                    });
— ハカン
ソース
0

あなたはこれをずっと短くすることができます

public enum Test
    {
        Test1 = 1,
        Test2 = 2,
        Test3 = 3
    }
    class Program
    {
        static void Main(string[] args)
        {

            var items = Enum.GetValues(typeof(Test));

            foreach (var item in items)
            {
                //Gives you the names
                Console.WriteLine(item);
            }


            foreach(var item in (Test[])items)
            {
                // Gives you the numbers
                Console.WriteLine((int)item);
            }
        }
    }
— ヘンキー85
ソース
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.