asp.netmvc2自定义DropdownList控件

asp.net mvc 2 给我们提供了强大的自定义功能，今天主要说下DropdownList自定义绑定字段显示，通过ViewData设定DropdownList的数据项。自动绑定显示。实现的方式。在global.asax 中注册 FieldTemplateMetadataProvider，

1. ModelMetadataProviders.Current = new mvc.Models.FieldTemplateMetadataProvider(); 

通过返回的 FieldTemplateMetadata 。在MetaData中指定使用DropDownList的字段

1. [Display( Name="",Order=12)] 
2.         [Required] 
3.         [SearchFilter] 
4.         [DisplayName("栏目")] 
5.         [DropDownList("Category", "Id", "Name")] 
6.         public int Cid { get; set; } 

通过DropDownList指定调用的模板为dropdownlist.ascx ,在dropdownlist.ascx 将默认的 ModelMetadata 转成FieldTemplateMetadata 获取 DropDownListAttribute 。

1. <script runat="server"> 
2.     DropDownListAttribute GetDropDownListAttribute() 
3.     { 
4.         FieldTemplateMetadata metaData = ViewData.ModelMetadata as FieldTemplateMetadata; 
5.   
6.         return (metaData != null) ? metaData.Attributes.OfType<DropDownListAttribute>().SingleOrDefault() : null; 
7.     } 
8. </script> 

通过DropDownListAttribute 获得 ViewData的key ，绑定的文本对应的字段，值对应的字段，使用html.DropDownlist显示数据
    DropdownList.ascx 代码

1. <%@ Import Namespace="mvc.Models"%> 
2. <%@ Control Language="C#" Inherits="System.Web.Mvc.ViewUserControl" %> 
3. <script runat="server"> 
4.     DropDownListAttribute GetDropDownListAttribute() 
5.     { 
6.         FieldTemplateMetadata metaData = ViewData.ModelMetadata as FieldTemplateMetadata; 
7.  
8.         return (metaData != null) ? metaData.Attributes.OfType<DropDownListAttribute>().SingleOrDefault() : null; 
9.     } 
10. </script> 
11. <% DropDownListAttribute attribute = GetDropDownListAttribute();%> 
12. <% if (attribute != null) {%> 
13.     <%= Html.DropDownList(string.Empty, new SelectList(ViewData[attribute.ViewDataKey] as IEnumerable, attribute.DataValueField, attribute.DataTextField, Model), attribute.OptionLabel, attribute.HtmlAttributes) %> 
14. <% }%> 
15. <% else {%> 
16.     <%= Html.DisplayForModel() %> 
17. <% }%> 

自定义DropDownListAttribute 属性

1. namespace mvc.Models 
2. { 
3.     using System; 
4.     using System.Collections.Generic; 
5.     using System.ComponentModel; 
6.     using System.ComponentModel.DataAnnotations; 
7.     using System.Linq; 
8.     using System.Web.Routing; 
9.  
10.     [AttributeUsage(AttributeTargets.Property, AllowMultiple = false, Inherited = true)] 
11.     public sealed class DropDownListAttribute : Attribute, ITemplateField 
12.     { 
13.         private static string defaultTemplateName; 
14.  
15.         public DropDownListAttribute(string viewDataKey, string dataValueField) : this(viewDataKey, dataValueField, null) 
16.         { 
17.         } 
18.  
19.         public DropDownListAttribute(string viewDataKey, string dataValueField, string dataTextField) : this(viewDataKey, dataValueField, dataTextField, null) 
20.         { 
21.         } 
22.  
23.         public DropDownListAttribute(string viewDataKey, string dataValueField, string dataTextField, string optionLabel) : this(DefaultTemplateName, viewDataKey, dataValueField, dataTextField, optionLabel, null) 
24.         { 
25.         } 
26.  
27.         public DropDownListAttribute(string viewDataKey, string dataValueField, string dataTextField, string optionLabel, object htmlAttributes) : this(DefaultTemplateName, viewDataKey, dataValueField, dataTextField, optionLabel, htmlAttributes) 
28.         { 
29.         } 
30.  
31.         public DropDownListAttribute(string templateName, string viewDataKey, string dataValueField, string dataTextField, string optionLabel, object htmlAttributes) 
32.         { 
33.             if (string.IsNullOrEmpty(templateName)) 
34.             { 
35.                 throw new ArgumentException("Template name cannot be empty."); 
36.             } 
37.  
38.             if (string.IsNullOrEmpty(viewDataKey)) 
39.             { 
40.                 throw new ArgumentException("View data key cannot be empty."); 
41.             } 
42.  
43.             if (string.IsNullOrEmpty(dataValueField)) 
44.             { 
45.                 throw new ArgumentException("Data value field cannot be empty."); 
46.             } 
47.  
48.             TemplateName = templateName; 
49.             ViewDataKey = viewDataKey; 
50.             DataValueField = dataValueField; 
51.             DataTextField = dataTextField; 
52.             OptionLabel = optionLabel; 
53.             HtmlAttributes = new RouteValueDictionary(htmlAttributes); 
54.         } 
55.  
56.         public static string DefaultTemplateName 
57.         { 
58.             get 
59.             { 
60.                 if (string.IsNullOrEmpty(defaultTemplateName)) 
61.                 { 
62.                     defaultTemplateName = "DropDownList"; 
63.                 } 
64.  
65.                 return defaultTemplateName; 
66.             } 
67.             set 
68.             { 
69.                 defaultTemplateName = value; 
70.             } 
71.         } 
72.  
73.         public string TemplateName { get; private set; } 
74.  
75.         public string ViewDataKey { get; private set; } 
76.  
77.         public string DataValueField { get; private set; } 
78.  
79.         public string DataTextField { get; private set; } 
80.  
81.         public string OptionLabel { get; private set; } 
82.  
83.         public IDictionary<string, object> HtmlAttributes { get; private set; } 
84.  
85.         public object GetSelectedValue(object model) 
86.         { 
87.             return GetPropertyValue(model, DataValueField); 
88.         } 
89.  
90.         public object GetSelectedText(object model) 
91.         { 
92.             return GetPropertyValue(model, !string.IsNullOrEmpty(DataTextField) ? DataTextField : DataValueField); 
93.         } 
94.  
95.         private static object GetPropertyValue(object model, string propertyName) 
96.         { 
97.             if (model != null) 
98.             { 
99.                 PropertyDescriptor property = GetTypeDescriptor(model.GetType()).GetProperties() 
100.                                                                                 .Cast<PropertyDescriptor>() 
101.                                                                                 .SingleOrDefault(p => string.Compare(p.Name, propertyName, StringComparison.OrdinalIgnoreCase) == 0); 
102.                 
103.                 if (property != null) 
104.                 { 
105.                     return property.GetValue(model); 
106.                 } 
107.             } 
108.  
109.             return null; 
110.         } 
111.  
112.         private static ICustomTypeDescriptor GetTypeDescriptor(Type type) 
113.         { 
114.             return new AssociatedMetadataTypeTypeDescriptionProvider(type).GetTypeDescriptor(type); 
115.         } 
116.     } 
117. } 

自定义DataAnnotationsModelMetadata

1. public class FieldTemplateMetadata : DataAnnotationsModelMetadata 
2.     { 
3.         public FieldTemplateMetadata(DisplayAttribute aa, DataAnnotationsModelMetadataProvider provider, Type containerType, Func<object> modelAccessor, Type modelType, string propertyName, DisplayColumnAttribute displayColumnAttribute, IEnumerable<Attribute> attributes) : base(provider, containerType, modelAccessor, modelType, propertyName, displayColumnAttribute) 
4.         { 
5.             Attributes = new List<Attribute>(attributes); 
6.             Display = aa; 
7.         } 
8.  
9.         public IList<Attribute> Attributes 
10.         { 
11.             get; 
12.             private set; 
13.         } 
14.         public DisplayAttribute Display { get; set; } 
15.     } 

自定义 DataAnnotationsModelMetadataProvider

1. public class FieldTemplateMetadataProvider : DataAnnotationsModelMetadataProvider 
2.     { 
3.         protected override ModelMetadata CreateMetadata(IEnumerable<Attribute> attributes, Type containerType, Func<object> modelAccessor, Type modelType, string propertyName) 
4.         { 
5.             DataAnnotationsModelMetadata result = (DataAnnotationsModelMetadata) base.CreateMetadata(attributes, containerType, modelAccessor, modelType, propertyName); 
6.  
7.             string templateName = attributes.OfType<ITemplateField>() 
8.                                             .Select(field => field.TemplateName) 
9.                                             .LastOrDefault(); 
10.             List<System.Attribute> attributeList = new List<System.Attribute>(attributes); 
11.             DisplayAttribute disp = attributeList.OfType<DisplayAttribute>().FirstOrDefault(); 
12.             if (disp != null) 
13.             { 
14.                 result.ShortDisplayName = disp.Order.ToString(); ; 
15.                 result.Description = disp.Description; 
16.             } 
17.  
18.             
19.  
20.             var data= (new FieldTemplateMetadata(disp, this, containerType, modelAccessor, modelType, propertyName, attributes.OfType<DisplayColumnAttribute>().FirstOrDefault(), attributes) 
21.  
22.                     { 
23.                         TemplateHint = !string.IsNullOrEmpty(templateName) ? templateName : result.TemplateHint, 
24.                         HideSurroundingHtml = result.HideSurroundingHtml, 
25.                         DataTypeName = result.DataTypeName, 
26.                         IsReadOnly = result.IsReadOnly, 
27.                         NullDisplayText = result.NullDisplayText, 
28.                         DisplayFormatString = result.DisplayFormatString, 
29.                         ConvertEmptyStringToNull = result.ConvertEmptyStringToNull, 
30.                         EditFormatString = result.EditFormatString, 
31.                         ShowForDisplay = result.ShowForDisplay, 
32.                         ShowForEdit = result.ShowForEdit, 
33.                         DisplayName = result.DisplayName, 
34.                         Description = result.Description, 
35.                         ShortDisplayName = result.ShortDisplayName, 
36.  
37.                     }); 
38.  
39.             SearchFilterAttribute searchFilterAttribute = attributes.OfType<SearchFilterAttribute>().FirstOrDefault(); 
40.             if (searchFilterAttribute != null) 
41.             { 
42.                 data.AdditionalValues.Add("Search", searchFilterAttribute); 
43.             } 
44.  
45.             OrderByAttribute orderByAttribute = attributes.OfType<OrderByAttribute>().FirstOrDefault(); 
46.             if (orderByAttribute != null) 
47.             { 
48.                 data.AdditionalValues.Add("OrderBy", orderByAttribute); 
49.             } 
50.             return data; 
51.         } 
52.     }