本文向讀者介紹NBear中實作的DropDownListField欄位綁定控制項和EnumDescriptionAttribute特性。結合使用這兩個元件，就可以最簡單、易用且可擴充地完美解決綁定Enum到ASP.NET資料綁定控制項的問題。 [05/26修訂]－增加支援第三方枚舉描述，支援二進位與過的枚舉值。
從DropDownListField的名稱，大家一定猜到了，是的，DropDownListField控制項和ASP.NET內建的BoundField，CheckBoxField等一樣，可以直接用於GridView，DetailsView等控制項的聲明中，用來描述一個Enum類型的欄位的綁定定。使用DropDownListField，我們就再也不需要向原來一樣為了綁定一個Enum類型的值而使用自訂ItemTemplate並嵌入DropDownList，並寫額外程式碼來填充ItemTemplate中的DropDownList了。
首先，我們先看看如何在我們的頁面程式碼中使用DropDownListField控制項：
1<%@ Page Language="C#" %>
2<%@ Register TagPrefix="nb" Namespace="NBear.Web.Data" Assembly="NBear.Web.Data" %>
3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" " http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd ">
4<html xmlns=" http://www.w3.org/1999/xhtml " >
5<head runat="server">
6 <title>NBear DataSource Test</title>
7</head>
8<body>
9<form id="aspnetForm" runat="server">
10 <nb:NBearDataSource ID="TestDS" runat="server" ConnectionStringName="test access db"
11 TypeName="Entities.SimpleData" FilterExpression="{SimpleID} > 0" DefaultOrderByExpression="{SimpleID} DESC, {SimpleName}" />
12 <asp:GridView ID="TestGrid" runat="server" DataSourceID="TestDS" AllowSorting="True" AllowPaging="True"
13 PageSize="3" AutoGenerateEditButton="True" AutoGenerateDeleteButton="True" DataKeyNames="SimpleId" AutoGenerateColumns="False" >
14 <Columns>
15 <asp:BoundField DataField="SimpleId" HeaderText="SimpleId" SortExpression="SimpleId" />
16 <asp:BoundField DataField="SimpleName" HeaderText="SimpleName" SortExpression="SimpleName" />
17 <asp:CheckBoxField DataField="BoolVal" HeaderText="BoolVal" SortExpression="BoolVal"
18 Text="BoolVal" />
19 <nb:DropDownListField DataField="Status" HeaderText="Status" SortExpression="Status" EnumType="EntityDesigns.SimpleStatus" />
20 </Columns>
21 </asp:GridView>
22 <br />
23 <asp:DetailsView ID="TestDetail" runat="server" DataSourceID="TestDS" DefaultMode="Insert"
24 AutoGenerateInsertButton="True" AutoGenerateRows="False">
25 <Fields><asp:BoundField DataField="SimpleName" HeaderText="Name" />
26 <asp:CheckBoxField DataField="BoolVal" HeaderText="BoolVal" />
27 <nb:DropDownListField DataField="Status" HeaderText="Status" EnumType="EntityDesigns.SimpleStatus" />
28 </Fields>
29 </asp:DetailsView>
30</form>
31</body>
32</html>
請注意第2和第19，27行。在頁面中，首先要註冊NBear.Web.Data命名空間。接著，在資料控制項的Columns中，加入DropDownListField就行了，和ASP.NET內建的的CheckBoxField使用中的唯一區別是，DropDownListField必須額外設定一個EnumType屬性，顧名思義，就是綁定到這個Enum欄位的類型的控制項Enum欄位的類型的控制項FullName。
OK，就是這麼簡單。本頁面中使用到的SimpleStatus如下：
1 public enum SimpleStatus
2 {
3 Value1 = 1,
4 Value2 = 2
5 }
如果運行這個頁面，您將可以看到DropDownList中顯示的是Value1和Value2。
-
等1秒鐘，你一定要說，這還不是我想要的，因為，我需要枚舉值在DropDownList中顯示的文字描述是我需要的自訂資訊。
OK，接著就輪到本文的第二個主角──EnumDescriptionAttribute了。
只需要如下使用EnumDescriptionAttribute標註Value1和Value2就行：
1 public enum SimpleStatus
2 {
3 [NBear.Common.EnumDescription(DefaultDescription="Desc of Value1")]
4 Value1 = 1,
5 [NBear.Common.EnumDescription(DefaultDescription="Desc of Value2")]
6 Value2 = 2
7 }
OK，不需要任何額外設定了，再運行上面的頁面，您將能看到DropDownList中顯示的文字是我們指定的自訂資訊了。很酷不是嗎？
-
再等一秒鐘，我們還是不會滿足的，雖然我們可以指定自定義說明信息，但是，如果是多語言環境，我們需要運行時對枚舉值的顯示不同的文字信息，還有很多情況，我們需要從資料庫中的枚舉描述表讀取對枚舉的描述資訊。
對此，我們當然也提供了解決方案。
我們只需要繼承EnumDescriptionAttribute即可。下面的MyEnumDescriptionAttribute示範了一個自訂的枚舉描述實作：
1 public class MyEnumDescriptionAttribute : NBear.Common.EnumDescriptionAttribute
2 {
3 private static string[] customDescs = new string[] { "custom desc of Value1", null }; //the second value is null here to use the DefaultDescription set in enum definition
4
5 public override string GetDescription(object enumValue)
6 {
7 return customDescs[(int)enumValue] ?? base.GetDescription(enumValue);
8 }
9 }
這個類別重載了EnumDescriptionAttribute的GetDescription()方法，從一個記憶體中的陣列讀取描述資訊。類似的，我們也可以在這裡從資源文件或資料庫中讀取說明訊息，都只需要重載這個方法就可以了。
您一定注意到其中的註釋代碼了，假如，對某個枚舉值，我們的自定義方法取不到自定義的描述信息，那麼，它會首先查看對這個枚舉值標註的MyEnumDescriptionAttribute有沒有指定DefaultDescription，如果制定則回傳這個內容，否則就回傳枚舉值的ToString()內容。
使用MyEnumDescriptionAttribute描述SimpleStatus如下：
1 public enum SimpleStatus
2 {
3 [MyEnumDescription(DefaultDescription="Default Desc of Value1")]
4 Value1 = 1,
5 [MyEnumDescription(DefaultDescription="Default Desc of Value2")]
6 Value2 = 2
7 }
再次運行頁面，您將看到，DropDownList中對應Value1顯示的資訊為custom desc of Value1，而對應Value2顯示的資訊為Default Desc of Value2。為什麼呢？因為對Value1我們能取到MyEnumDescriptionAttribute回傳的自訂訊息，而對Value2，MyEnumDescriptionAttribute回傳null，那麼，預設的描述訊息將會被應用。是不是很神奇呢？
甚至，您可以對同一個Enum類型的不同成員項混合使用不同的EnumDescriptionAttribute或其繼承類別來指定描述資訊（有這樣的需求嗎^-^）。但是，每個枚舉項只有第一個EnumDescriptionAttribute或其繼承類別標註會生效，多餘的標註會被忽略。
好了，基本上介紹完了，鬥膽稱這個方案為完美方案，別丟臭雞蛋就好。 ：）
篇後語
除了結合資料綁定控制項使用EnumDescriptionAttribute之外，您也可以單獨使用EnumDescriptionAttribute以透明取得的枚舉值描述資訊。呼叫EnumDescriptionAttribute.GetDescriptions(enumType)這個靜態方法就可以得到指定枚舉類型的所有枚舉值的由EnumDescriptionAttribute或其繼承類別標註的描述資訊。
DropDownListField類別是參考ASP.NET內建的CheckBoxField類別所寫的。
下載
本文介紹的元件的全部原始碼和範例程式碼包含於最新版本的nbear中，EnumDescriptionAttribute定義於srcNBear.CommonEnumDescriptionAttribute.cs，DropDownListField定義於srcNBear.Web.DataDropDownListFieldDropDownListField定義於srcNBear.Web.DataDropDownListFieldDropDownListField。範例程式位於tutorialsNBearDataSourceSample。
可從NBear的官方網站下載：http: //nbear.org
-
[05/26修訂]—增加支援第三方枚舉描述，支援二進位與過的枚舉值。包含於NBearV3.7.1 build 7以上版本。
1.對於在第三方已編譯程式集中的枚舉類型，也就是說我們沒有機會直接添加EnumDescriptionAttribute到枚舉定義的，現在也支援了。只需要額外定義一個與外部枚舉類型對應的枚舉類型，保證兩個枚舉類型的枚舉項的int值相等即可，在這個新枚舉類型中標註EnumDescriptionAttribute即可。當然，此時，EnumType屬性需要填入新的枚舉型別名稱。
2.對於枚舉值支援二進位與的枚舉值，現在也支援了，無需額外設定。不過這種枚舉值的insert和edit如果需要更新為合併值，還是需要使用者自行寫程式完成。這裡僅僅是支持到顯示這樣的值。
//本文結束