转载自 C#自定义属性转换类—类型转换器
自定义属性转换类
在VS可视化工具栏中,我们设计winform窗体时可以通过属性窗口对窗体或者控件进行相关的属性操作设置,并立即刷新显示。如
在改变Font属性后,控件呈现的字体将发生改变,并且可以直接修改Font左边的值:“宋体,9pt”改为“微乳雅黑,15pt”(中间只能是英文逗号隔开)。那么属性编辑器是如何实现的呢?
微软在框架中添加了一个设计时框架,实现了一个属性转换类。
1、实现圆角矩形转换类的控制
此实例将实现圆角矩形属性在属性编辑窗口中编辑后的相关变化实现:
2、通用类型转换器
该类型转换器与圆角矩形属性转换器具有相似或更强大的功能,实现了不同属性之间的通用,避免针对不同属性开发不同的类型转换器。但某些也需要特定定制,如前面的Font,展开后有很多属性,但显示在左边的值只有部分设置后的显示。
实现通用类型转换器,主要使用了泛型与反射的技术:
/// <summary>
/// 实现类型属性分别编辑的通用类型转换器
/// </summary>
/// <typeparam name="T">泛型</typeparam>
class GeneralTypeConverter<T> : TypeConverter where T : new()
{
/// <summary>
/// 返回此转换器是否可以将一种类型的对象转换为此转换器的类型。
/// </summary>
/// <param name="context">提供格式上下文的ITypeDescriptorContext。</param>
/// <param name="sourceType">表示你想从转换的类型</param>
/// <returns>返回为True则可以转换,为false则不能转换</returns>
public override bool CanConvertFrom(ITypeDescriptorContext context, Type sourceType)
{
if (sourceType == typeof(string))
{
return true;
}
return base.CanConvertFrom(context, sourceType);
}
/// <summary>
/// 使用指定的上下文和区域性信息将给定对象转换为此转换器的类型
/// </summary>
/// <param name="context">一个 ITypeDescriptorContext,用于提供格式上下文</param>
/// <param name="culture">CultureInfo 要用作当前区域性</param>
/// <param name="value">要转换的 Object</param>
/// <returns>转换后的值</returns>
public override object ConvertFrom(ITypeDescriptorContext context, CultureInfo culture, object value)
{
string strValue = (value as string).Trim();
if (strValue == null)
{
return base.ConvertFrom(context, culture, value);
}
strValue = strValue.Trim();
if (strValue.Length == 0)
{
return null;
}
if (culture == null)
{
culture = CultureInfo.CurrentCulture;
}
char separator = ';';//采用英文分号隔开,与下面的ConvertTo对应
Type type = typeof(T);
//1、去掉“ClassName { ”和“ }”两部分 ,与下面的ConvertTo对应
string withStart = "{ ";
string withEnd = " }";
if (strValue.StartsWith(withStart) && strValue.EndsWith(withEnd))
{
strValue = strValue.Substring(withStart.Length, strValue.Length - withStart.Length - withEnd.Length);
}
//2、分割属性值
string[] strArray = strValue.Split(new char[] { separator });
//3、做成属性集合表
Hashtable properties = new Hashtable();
for (int i = 0; i < strArray.Length; i++)
{
if (strArray[i].Trim().IndexOf('=') != -1)
{
string[] str = strArray[i].Trim().Split(new char[] { '=' });
string propName = str[0];
PropertyInfo pi = type.GetProperty(str[0]);
if (pi != null)
{
//该属性对应类型的类型转换器
TypeConverter converter = TypeDescriptor.GetConverter(pi.PropertyType);
properties.Add(propName, converter.ConvertFromString(str[1]));
}
}
}
return this.CreateInstance(context, properties);
}
/// <summary>
/// 返回此转换器是否可将该对象转换为指定的类型。
/// </summary>
/// <param name="context">提供格式上下文的ITypeDescriptorContext。</param>
/// <param name="sourceType">表示你想从转换的类型</param>
/// <returns>返回为True则可以转换,为false则不能转换</returns>
public override bool CanConvertTo(ITypeDescriptorContext context, Type destinationType)
{
if (destinationType == typeof(InstanceDescriptor))
{
return true;
}
return base.CanConvertTo(context, destinationType);
}
/// <summary>
/// 使用指定的上下文和区域性信息将给定的值对象转换为指定的类型
/// </summary>
/// <param name="context">一个提供格式上下文的 System.ComponentModel.ITypeDescriptorContext。</param>
/// <param name="culture">System.Globalization.CultureInfo。如果传递 null,则采用当前区域性</param>
/// <param name="value"> 要转换的 System.Object。</param>
/// <param name="destinationType">value 参数要转换到的 System.Type。</param>
/// <returns>表示转换的 value 的 System.Object。</returns>
public override object ConvertTo(ITypeDescriptorContext context, CultureInfo culture, object value, Type destinationType)
{
if (destinationType == null)
{
throw new ArgumentNullException("DestinationType");
}
//如果需要返回详细信息则
if (value is T)
{
if (destinationType == typeof(string))
{
if (culture == null)
{
culture = CultureInfo.CurrentCulture;
}
string separator = "; ";//采用英文分号隔开,与ConvertFrom对应
StringBuilder sb = new StringBuilder();
Type type = value.GetType();
//组合为属性窗口显示的值
sb.Append("{ ");
PropertyInfo[] proInfo = type.GetProperties(BindingFlags.Instance | BindingFlags.Public);
for (int i = 0; i < proInfo.Length; i++)
{
if (!proInfo[i].CanRead) continue;
//只显示可见的
object[] attributes = proInfo[i].GetCustomAttributes(typeof(BrowsableAttribute),false);
bool isBrowsable = true;
foreach(object obj in attributes)
{
isBrowsable = (obj as BrowsableAttribute).Browsable;
}
if (isBrowsable == false)
{
continue;
}
Type typeProp = proInfo[i].PropertyType;
string nameProp = proInfo[i].Name;
object valueProp = proInfo[i].GetValue(value, null);
TypeConverter converter = TypeDescriptor.GetConverter(typeProp);
sb.AppendFormat("{0}={1}" + separator, nameProp, converter.ConvertToString(context, valueProp));
}
string strContent = sb.ToString();
if (strContent.EndsWith(separator))
{
strContent = strContent.Substring(0, strContent.Length - separator.Length);
}
strContent += " }";
return strContent.Trim();
}
if (destinationType == typeof(InstanceDescriptor))
{
ConstructorInfo constructor = typeof(T).GetConstructor(new Type[0]);
if (constructor != null)
{
return new InstanceDescriptor(constructor, new object[0], false);
}
}
}
return base.ConvertTo(context, culture, value, destinationType);
}
/// <summary>
/// 在已知对象的属性值集的情况下,使用指定的上下文创建与此关联的类型的实例。
/// </summary>
/// <param name="context">一个提供格式上下文的ITypeDescriptorContext</param>
/// <param name="propertyValues">新属性值的IDictionary。</param>
/// <returns>一个 System.Object,表示给定的IDictionary,或者,如果无法创建该对象,则为 null。此方法始终返回</returns>
public override object CreateInstance(ITypeDescriptorContext context, IDictionary propertyValues)
{
if (propertyValues == null)
{
throw new ArgumentNullException("propertyValues");
}
Type type = typeof(T);
ConstructorInfo ctrInfo = type.GetConstructor(new Type[0]);
if (ctrInfo == null)
{
return null;
}
//调用默认的构造函数构造实例
object obj = ctrInfo.Invoke(new object[0]);
//设置属性值
PropertyInfo[] proInfo = type.GetProperties(BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance);
object propValue = null;
for (int i = 0; i < proInfo.Length; i++)
{
//判断是否具有Set方法
if (!proInfo[i].CanWrite)
{
continue;
}
propValue = propertyValues[proInfo[i].Name];
if (propValue != null)
{
proInfo[i].SetValue(obj, propValue, null);
}
}
return obj;
}
/// <summary>
/// 返回更改此对象的值是否要求调用CreateInstance(System.Collections.IDictionary)方法来创建新值。
/// </summary>
/// <param name="context">一个提供格式上下文的 System.ComponentModel.ITypeDescriptorContext</param>
/// <returns>如果更改此对象的属性需要调用CreateInstance(System.Collections.IDictionary)来创建新值,则为 true;否则为 false。</returns>
public override bool GetCreateInstanceSupported(ITypeDescriptorContext context)
{
return true;
}
/// <summary>
/// 使用指定的上下文和特性返回由 value 参数指定的数组类型的属性的集合
/// </summary>
/// <param name="context">一个提供格式上下文的ITypeDescriptorContext</param>
/// <param name="value">一个 System.Object,指定要为其获取属性的数组类型</param>
/// <param name="attributes">用作筛选器的 System.Attribute 类型数组。</param>
/// <returns>具有为此数据类型公开的属性的 PropertyDescriptorCollection;或者,如果没有属性,则为null。</returns>
public override PropertyDescriptorCollection GetProperties(ITypeDescriptorContext context, object value, Attribute[] attributes)
{
Type type = value.GetType();
PropertyInfo[] proInfo = type.GetProperties(BindingFlags.Instance | BindingFlags.Public);
string[] names = new string[proInfo.Length];
for (int i = 0; i < names.Length; i++)
{
names[i] = proInfo[i].Name;
}
Array.Sort<string>(names);
return TypeDescriptor.GetProperties(typeof(T), attributes).Sort(names);
}
/// <summary>
/// 使用指定的上下文返回该对象是否支持属性。
/// </summary>
/// <param name="context">一个提供格式上下文的 System.ComponentModel.ITypeDescriptorContext</param>
/// <returns>如果应调用 System.ComponentModel.TypeConverter.GetProperties(System.Object) 来查找此对象的属性,则为true;否则为 false。</returns>
public override bool GetPropertiesSupported(ITypeDescriptorContext context)
{
return true;
}
}
应用
[Browsable(true), Category("自定义属性"), Description("边框颜色"), TypeConverter(typeof(GeneralTypeConverter<BorderColor>))]
public class BorderColor
{
[Description("上边框颜色")]
public Color Top { get; set; }
[Description("右边框颜色")]
public Color Right { get; set; }
[Description("下边框颜色")]
public Color Bottom { get; set; }
[Description("左边框颜色")]
public Color Left { get; set; }
public BorderColor() { }
public BorderColor(Color left, Color top, Color right,Color bottom)
{
Top = top;
Right = right;
Bottom = bottom;
Left = left;
}
}