自定义类在PropertyGrid上的展示方法
自定義類在PropertyGrid上的展示方法
零.引言
PropertyGrid用來顯示某一對(duì)象的屬性，但是并不是所有的屬性都能編輯，基本數(shù)據(jù)類型（int， double等）和.Net一些封裝的類型（Size，Color等）可以編輯，但是對(duì)于自己定義的類型屬性，是不能編輯的，本文主要講述如何為自定義類型作為屬性時(shí)，在PropertyGrid中進(jìn)行編輯，以及進(jìn)行設(shè)計(jì)時(shí)序列化，本文主要參考MSDN，錯(cuò)誤和不足之處還望指正。
一．自定義類屬性
在PropertyGrid中能夠編輯的都是.Net中自己封裝的類，如果在一個(gè)類中有一個(gè)屬性是我們自己定義的類型，在PropertyGrid中會(huì)是怎樣的呢？看下面這個(gè)例子：
假如現(xiàn)在有一個(gè)類Line：
?Line? 有一個(gè)控件類包含一個(gè)Line類型的屬性：
1 public class MyControl : System.Windows.Forms.UserControl2 {3 Line _line;4 5 public MyControl()6 {7 _line = new Line(new Point(0, 0),new Point(100, 100));8 }9 10 public Line MyLine 11 { 12 get{return _line;} 13 set{_line = value;} 14 } 15 16 protected override void OnPaint(System.Windows.Forms.PaintEventArgs e) 17 { 18 e.Graphics.DrawLine(Pens.Red, this._line.Point1, this._line.Point2); 19 base.OnPaint(e); 20 } 21 }重新生成，從工具箱中將該控件拖入Form中，查看他的屬性，在PropertyGrid中顯示如下：
可見MyLine屬性的值不顯示，且是不能編輯的。這是因?yàn)镻ropertyGrid根本不知道Line是個(gè)什么類型，不知道要怎么顯示，如果要其能在PropertyGrid中顯示，必須給他提供轉(zhuǎn)換器。
二．轉(zhuǎn)換器概念
PropertyGrid中屬性的值都是以字符串的形式呈現(xiàn)給我們看的，顯示一個(gè)對(duì)象的屬性時(shí)，要將對(duì)象的屬性值轉(zhuǎn)換為字符串顯示出來，而設(shè)置屬性時(shí)，要將字符串轉(zhuǎn)換為對(duì)象的屬性值。這就需要一個(gè)轉(zhuǎn)換器。在.Net中定義了一個(gè)TypeConverter?類，用來作為這些轉(zhuǎn)換器的基類。.Net為一些類設(shè)計(jì)了專門的轉(zhuǎn)換類，如：System.Drawing.ColorConverter ，System.Drawing.FontConverter等等，（具體參見MSDN中TypeConverter的繼承關(guān)系）因此在PropertyGrid中能直接編輯這些屬性。我們自己定義的類沒有這樣的類型轉(zhuǎn)換器，因此在PropertyGrid中無法編輯，需要設(shè)計(jì)自己的轉(zhuǎn)換器。
先來看一下MSDN中對(duì)TypeConverter的描述：TypeConverter類提供一種將值的類型轉(zhuǎn)換為其他類型以及訪問標(biāo)準(zhǔn)值和子屬性的統(tǒng)一方法。
繼承者說明：
從 TypeConverter 繼承，以實(shí)現(xiàn)您自己的轉(zhuǎn)換要求。當(dāng)從類繼承時(shí)，可以重寫以下方法：
- 若要支持自定義類型轉(zhuǎn)換，請重寫?CanConvertFrom、CanConvertTo、ConvertFrom?和?ConvertTo?方法。
- 若要轉(zhuǎn)換必須重新創(chuàng)建對(duì)象才能更改其值的類型，請重寫?CreateInstance?和?GetCreateInstanceSupported?方法。
- 若要轉(zhuǎn)換支持屬性 (Property) 的類型，請重寫?GetProperties?和?GetPropertiesSupported?方法。如果轉(zhuǎn)換的類沒有屬性 (Property)，而您需要實(shí)現(xiàn)屬性 (Property)，則可以將?TypeConverter.SimplePropertyDescriptor?類用作實(shí)現(xiàn)屬性 (Property) 說明符的基。當(dāng)從?TypeConverter.SimplePropertyDescriptor?繼承時(shí)，必須重寫 GetValue 和 SetValue 方法。
- 若要轉(zhuǎn)換支持標(biāo)準(zhǔn)值的類型，請重寫?GetStandardValues、GetStandardValuesExclusive、GetStandardValuesSupported?和?IsValid?方法。
三．添加轉(zhuǎn)換器
好了，了解了基本原理后，我們來為Line添加轉(zhuǎn)換器。這里新建一個(gè)LineConverter類，并繼承于TypeConverter。
?LineConverter在轉(zhuǎn)換器類中，我們重寫了四個(gè)函數(shù)，也就是在繼承者說明中第一條的四個(gè)函數(shù)：
①?CanConvertTo：用來說明此類可以轉(zhuǎn)換為哪些類型，能轉(zhuǎn)換就返回true，這里我們讓他能轉(zhuǎn)換為string和InstanceDescriptor，InstanceDescriptor是存儲(chǔ)描述對(duì)象實(shí)例的信息，這些信息可用于創(chuàng)建對(duì)象的實(shí)例。一般轉(zhuǎn)換都要實(shí)現(xiàn)這個(gè)轉(zhuǎn)換，后面進(jìn)行說明。
②?CanConvertFrom：說明該類能有什么類型轉(zhuǎn)換過來，能轉(zhuǎn)換返回true，這里只對(duì)string類型進(jìn)行轉(zhuǎn)換。
③?ConvertTo：具體的轉(zhuǎn)換實(shí)現(xiàn)，也就是提供方法將該類轉(zhuǎn)換為在CanConvertTo中確定可以轉(zhuǎn)換的類型。這里實(shí)現(xiàn)string和InstanceDescriptor的轉(zhuǎn)換。
④?ConvertFrom：具體的轉(zhuǎn)換實(shí)現(xiàn)，也就是提供方法將該類轉(zhuǎn)換為在CanConvertFrom中確定可以轉(zhuǎn)換的類型。這里實(shí)現(xiàn)string的轉(zhuǎn)換。
注意，每個(gè)方法處理完自己的轉(zhuǎn)換后，依然要調(diào)用基類的函數(shù)來處理其他的情況。
重寫這四個(gè)方法后，給Line類型加上TypeConverter特性，在Line類定義的上面加上[TypeConverter(typeof(LineConverter))]。這樣在需要轉(zhuǎn)換的地方，就會(huì)調(diào)用我們所寫的方法進(jìn)行轉(zhuǎn)換，Line屬性在PropertyGrid中顯示時(shí)，會(huì)調(diào)用ConvertTo，轉(zhuǎn)換為字符串輸出；設(shè)置屬性時(shí)，會(huì)調(diào)用ConvertFrom將字符串轉(zhuǎn)換為屬性值，當(dāng)然，字符串必須要有一定的格式，這就需要在轉(zhuǎn)換的過程中進(jìn)行判斷，見ConvertFrom方法。
重新生成，現(xiàn)在看MyControl中MyLine屬性在PropertyGrid中的顯示：
可以看到MyLine屬性顯示出來了（以x1,y1,x2,y2的格式，我們在ConverTo方法中指定的），并可以編輯了，但必須是x1,y1,x2,y2的格式，否則會(huì)出現(xiàn)如下錯(cuò)誤提示：
這是我們在ConvertFrom方法中進(jìn)行判斷的。
四．編輯復(fù)雜屬性的子屬性
現(xiàn)在可以編輯屬性了，但是必須使用x1,y1,x2,y2固定的格式，不方便，而且容易出錯(cuò)，可不可以分別設(shè)置Line的兩個(gè)點(diǎn)呢，可以，這里就需要編輯子屬性了。Line中有Point1和Point2兩個(gè)屬性，我們讓他們也顯示出來。
這里就是繼承者說明中的第三條了。重寫?GetProperties?和?GetPropertiesSupported?方法。在LineConverter中重寫這兩個(gè)方法：
1 public override bool GetPropertiesSupported(ITypeDescriptorContext context)2 {3 return true;4 //return base.GetPropertiesSupported(context);5 }6 7 public override PropertyDescriptorCollection GetProperties(ITypeDescriptorContext context, object value, Attribute[] attributes)8 {9 return TypeDescriptor.GetProperties(value, attributes); 10 //return base.GetProperties(context, value, attributes); 11 } 12重新生成，現(xiàn)在看MyControl中MyLine屬性在PropertyGrid中的顯示：
可以看到現(xiàn)在我們可以編輯MyLine的子屬性了。
五．屬性的設(shè)計(jì)時(shí)串行化
最后說一說ConvertTo方法中為什么要實(shí)現(xiàn)InstanceDescriptor的轉(zhuǎn)換。Visual Studio在我們編輯控件時(shí)，會(huì)在Form1.Designer.cs文件中自動(dòng)的生成代碼，設(shè)置控件的屬性，這叫屬性對(duì)設(shè)計(jì)時(shí)序列化，如下：
我們定義的MyLine屬性，在這里并沒有，如何使它出現(xiàn)在這里呢，只需給MyLine屬性加上DesignerSerializationVisibility特性。如下
1 [DesignerSerializationVisibility(DesignerSerializationVisibility.Visible)] 2 public Line MyLine3 {4 get5 {6 return _line;7 }8 set9 { 10 _line = value; 11 } 12 } 13這里DesignerSerializationVisibility.Visible表明代碼生成器生成對(duì)象的代碼。DesignerSerializationVisibility.Content說明該屬性在編輯時(shí)要代碼生成器產(chǎn)生對(duì)象內(nèi)容的代碼，而不是對(duì)象本身的代碼。DesignerSerializationVisibility.Hide代碼生成器不生成對(duì)象的代碼。
重新生成，并改變控件的位置，打開Form1.Designer.cs，會(huì)發(fā)現(xiàn)自動(dòng)生成了MyLine屬性的設(shè)置值。
這是如何生成的呢，關(guān)鍵就在ConvertTo方法中實(shí)現(xiàn)InstanceDescriptor的轉(zhuǎn)換，該方法告訴代碼生成器，如何去構(gòu)造一個(gè)Line類型，生成時(shí)，調(diào)用Line的構(gòu)造函數(shù)構(gòu)造新對(duì)象初始化MyLine屬性值。
六．總體的代碼
下面是完整的代碼：
1 using System;2 using System.ComponentModel;3 using System.ComponentModel.Design.Serialization;4 using System.Drawing;5 using System.Globalization;6 using System.Reflection;7 8 namespace TestTypeConverter9 {10 //線條類11 [TypeConverter(typeof(LineConverter))]12 public class Line13 {14 // Line members.15 Point P1;16 Point P2;17 18 public Point Point119 {20 get21 {22 return P1;23 }24 set25 {26 P1 = value;27 }28 }29 30 public Point Point231 {32 get33 {34 return P2;35 }36 set37 {38 P2 = value;39 }40 }41 42 public Line(Point point1, Point point2)43 {44 P1 = point1;45 P2 = point2;46 }47 }48 49 //轉(zhuǎn)換器類50 public class LineConverter : TypeConverter51 {52 public override bool CanConvertTo(ITypeDescriptorContext context, Type destinationType)53 {54 if (destinationType == typeof(string))55 {56 return true;57 }58 59 if (destinationType == typeof(InstanceDescriptor))60 {61 return true;62 }63 return base.CanConvertTo(context, destinationType);64 }65 66 public override bool CanConvertFrom(ITypeDescriptorContext context, Type sourceType)67 {68 if (sourceType == typeof(string))69 {70 return true;71 }72 73 return base.CanConvertFrom(context, sourceType);74 }75 76 public override object ConvertTo(ITypeDescriptorContext context, CultureInfo culture, object value, Type destinationType)77 {78 if (destinationType == typeof(string) && value != null)79 {80 Line t = (Line)value;81 string str = t.Point1.X + "," + t.Point1.Y + "," + t.Point2.X + "," + t.Point2.Y;82 return str;83 }84 85 if (destinationType == typeof(InstanceDescriptor))86 {87 ConstructorInfo ci = typeof(TestTypeConverter.Line).GetConstructor(new Type[] { typeof(Point), typeof(Point) });88 Line t = (Line)value;89 return new InstanceDescriptor(ci, new object[] { t.Point1, t.Point2 });90 }91 return base.ConvertTo(context, culture, value, destinationType);92 }93 94 public override object ConvertFrom(ITypeDescriptorContext context, CultureInfo culture, object value)95 {96 if (value is string)97 {98 string str = (string)value;99 str = str.Trim(); 100 string[] v = str.Split(','); 101 if (v.Length != 4) 102 { 103 throw new NotSupportedException("Invalid parameter format"); 104 } 105 106 int x1 = 0; 107 int y1 = 0; 108 int x2 = 0; 109 int y2 = 0; 110 bool res = int.TryParse(v[0], out x1); 111 if (res == false) throw new NotSupportedException("Invalid parameter format"); 112 res = int.TryParse(v[1], out y1); 113 if (res == false) throw new NotSupportedException("Invalid parameter format"); 114 res = int.TryParse(v[2], out x2); 115 if (res == false) throw new NotSupportedException("Invalid parameter format"); 116 res = int.TryParse(v[3], out y2); 117 if (res == false) throw new NotSupportedException("Invalid parameter format"); 118 119 Line line = new Line(new Point(x1, y1), new Point(x2, y2)); 120 return line; 121 } 122 123 return base.ConvertFrom(context, culture, value); 124 } 125 126 127 public override bool GetPropertiesSupported(ITypeDescriptorContext context) 128 { 129 return true; 130 //return base.GetPropertiesSupported(context); 131 } 132 133 public override PropertyDescriptorCollection GetProperties(ITypeDescriptorContext context, object value, Attribute[] attributes) 134 { 135 return TypeDescriptor.GetProperties(value, attributes); 136 //return base.GetProperties(context, value, attributes); 137 } 138 } 139 140 //控件類 141 public class MyControl : System.Windows.Forms.UserControl 142 { 143 Line _line; 144 145 public MyControl() 146 { 147 _line = new TestTypeConverter.Line( 148 new Point(0, 0), 149 new Point(100, 100) 150 ); 151 } 152 153 [DesignerSerializationVisibility(DesignerSerializationVisibility.Visible)] 154 public Line MyLine 155 { 156 get 157 { 158 return _line; 159 } 160 set 161 { 162 _line = value; 163 } 164 } 165 166 protected override void OnPaint(System.Windows.Forms.PaintEventArgs e) 167 { 168 e.Graphics.DrawLine(Pens.Red, this._line.Point1, this._line.Point2); 169 base.OnPaint(e); 170 } 171 } 172 }新建一個(gè)Windows工程，添加該文件，在工具箱中找到我們的MyControl控件，拖入Form中，在屬性框中查看控件的屬性。
?
轉(zhuǎn)載于:https://www.cnblogs.com/pdf2pdf/p/8232069.html
總結(jié)
以上是生活随笔為你收集整理的自定义类在PropertyGrid上的展示方法的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： Web移动适配笔记（ing）
- 下一篇： 两个指针相减