C#基础系列：开发自己的窗体设计器（PropertyGrid显示中文属性名）

既然是一个窗体设计器，那就应该能够设置控件的属性，设置属性最好的当然是PropertyGrid了，我们仅仅需要使用一个PropertyGrid.SelectedObject = Control就可以搞定，让PropertyGrid显示Control的所有属性。可是这里显示的属性名是英文的。对于我们开发人员来说这无可厚非，我们也乐于接受。并且让PropertyGrid显示中文属性名，这对于我们开发人员的使用来说显得多此一举。可是，对于我这种类型的一个应用工具，英文属性名对于很多客户来说可能就很难懂了。所以应该让PrpertyGrid能够显示中文属性名。

如图：

另外，对于这样的一个系统。并不是控件的所有属性都是用户希望的，可能用户希望看到的仅仅是控件高度、控件宽度、控件文本。。等等的属性，但是如果直接将一个控件属性全部显示给用户的话，估计对用户造成的干扰和困惑是很大的。如何解决这个问题呢？其实用户控件开发的时候，如果我们不希望此属性在PropertyGrid中显示，我们可以设置这个控件的Attribute，如：

[Browsable(false)]<?xml:namespace prefix = o ns = "urn:schemas-microsoft-com:office:office" />

public int Width

{

get { }

set { }

}

通过使用BrowsableAttribute就可以设置将此属性对PropertyGrid隐藏。

你可能要问到了，对于控件来说，其中的很多属性都是直接继承来的，我们并没有办法控制是否对PropertyGrid隐藏啊？呵呵，对啊，这就是我下面要说的解决方法（当然此方法显得不是很灵活，但是对于这种类型的系统的确相当有用）。

在我的解决方式中，我不直接这样PropertyGrid.SelectedObject = Control，而是把这个Control替换成一个专门为此类型的Control设计的类对象上。比如我对TextBox设计了一个TextBoxProperty，这样我们使用的是PropertyGrid.SelectedObject = TextBoxProperty的一个对象。

下面就是TextBoxProperty的代码：

1. publicclassTextBoxProperty:PropertyBase
2. {
3. privateTextBox_Control;
5. publicTextBoxProperty()
6. {
7. }
9. publicTextBoxProperty(TextBoxcontrol)
10. {
11. this._Control=control;
12. }
14. [MyControlAttibute("文本","获取或者设置控件文本","")]
15. publicstringText
16. {
17. get{returnthis._Control.Text;}
18. set
19. {
20. this._Control.Text=value;
21. }
22. }
24. [MyControlAttibute("宽度","获取或者设置控件宽度","")]
25. publicintWidth
26. {
27. get{returnthis._Control.Width;}
28. set
29. {
30. this._Control.Width=(int)value;
31. }
32. }
34. [MyControlAttibute("高度","获取或者设置控件高度","")]
35. publicintHeight
36. {
37. get{returnthis._Control.Height;}
38. set
39. {
40. this._Control.Height=(int)value;
41. }
42. }
44. [MyControlAttibute("上边距","获取或者设置控件上边位置","")]
45. publicintTop
46. {
47. get{returnthis._Control.Top;}
48. set
49. {
50. this._Control.Top=value;
51. }
52. }
54. [MyControlAttibute("左边距","获取或者设置控件左边位置","")]
55. publicintLeft
56. {
57. get{returnthis._Control.Left;}
58. set
59. {
60. this._Control.Left=value;
61. }
62. }
64. [MyControlAttibute("背景色","获取或者设置控件背景颜色","")]
65. publicColorBackColor
66. {
67. get{returnthis._Control.BackColor;}
68. set
69. {
70. this._Control.BackColor=value;
71. }
72. }
74. [MyControlAttibute("前景色","获取或者设置控件的前景颜色","")]
75. publicColorForeColor
76. {
77. get{returnthis._Control.ForeColor;}
78. set
79. {
80. this._Control.ForeColor=value;
81. }
82. }
83. }

你从代码里面已经看出了一些端倪了，在TextBoxProperty中每个要属性都增加了MyControlAttibute，具体Attribute的概念和使用方法您可以参考我的另一篇Blog文《C#基础系列：实现自己的ORM（反射以及Attribute在ORM中的应用）》。这里对Attribute做了详细的介绍（对初学者有效）。所以我就直接贴出MyControlAttibute的代码好了：

1. publicclassMyControlAttibute:Attribute
2. {
3. privatestring_PropertyName;
4. privatestring_PropertyDescription;
5. privateobject_DefaultValue;
7. publicMyControlAttibute(stringName,stringDescription,objectDefalutValue)
8. {
9. this._PropertyName=Name;
10. this._PropertyDescription=Description;
11. this._DefaultValue=DefalutValue;
12. }
14. publicMyControlAttibute(stringName,stringDescription)
15. {
16. this._PropertyName=Name;
17. this._PropertyDescription=Description;
18. this._DefaultValue="";
19. }
21. publicMyControlAttibute(stringName)
22. {
23. this._PropertyName=Name;
24. this._PropertyDescription="";
25. this._DefaultValue="";
26. }
28. publicstringPropertyName
29. {
30. get{returnthis._PropertyName;}
31. }
33. publicstringPropertyDescription
34. {
35. get{returnthis._PropertyDescription;}
36. }
38. publicobjectDefaultValue
39. {
40. get{returnthis._DefaultValue;}
41. }
42. }

通过上面的两段代码，你已经初步看出了在PropertyGrid中显示中文属性以及仅仅显示我们需要的属性的基本思路。下面就介绍的就是怎么让MyControlAttibute中定义了的中文属性名在PropertyGrid中显示出来。下面这段代码，我仅仅贡献了PropertyStub中这个函数的实现。所以不做过多解释了：

1. publicoverridestringDisplayName
2. {
3. get
4. {
5. if(info!=null)
6. {
7. MyControlAttibuteuicontrolattibute=(MyControlAttibute)Attribute.GetCustomAttribute(info,typeof(MyControlAttibute));
8. if(uicontrolattibute!=null)
9. returnuicontrolattibute.PropertyName;
10. else
11. {
12. returninfo.Name;
13. }
14. }
15. else
16. return"";
17. }
18. }

整个代码如下，里面包含两个类，你直接拷贝出来就可以使用了：

1. publicdelegatevoidPropertyChanged(objectValue);
3. ///<summary>
4. ///主要是实现中文化属性显示
5. ///</summary>
6. publicclassPropertyBase:ICustomTypeDescriptor
7. {
8. ///<summary>
9. ///下面这段代码来源于：http://www.bluespace.cn/Html/Csdn/2_47/View_4702219.html
10. ///</summary>
11. ///<returns></returns>
12. #regionICustomTypeDescriptor显式接口定义
13. AttributeCollectionICustomTypeDescriptor.GetAttributes()
14. {
15. returnTypeDescriptor.GetAttributes(this,true);
16. }
18. stringICustomTypeDescriptor.GetClassName()
19. {
20. returnTypeDescriptor.GetClassName(this,true);
21. }
23. stringICustomTypeDescriptor.GetComponentName()
24. {
25. returnTypeDescriptor.GetComponentName(this,true);
26. }
28. TypeConverterICustomTypeDescriptor.GetConverter()
29. {
30. returnTypeDescriptor.GetConverter(this,true);
31. }
33. EventDescriptorICustomTypeDescriptor.GetDefaultEvent()
34. {
35. returnTypeDescriptor.GetDefaultEvent(this,true);
36. }
38. PropertyDescriptorICustomTypeDescriptor.GetDefaultProperty()
39. {
40. returnnull;
41. }
43. objectICustomTypeDescriptor.GetEditor(TypeeditorBaseType)
44. {
45. returnTypeDescriptor.GetEditor(this,editorBaseType,true);
46. }
48. EventDescriptorCollectionICustomTypeDescriptor.GetEvents()
49. {
50. returnTypeDescriptor.GetEvents(this,true);
51. }
53. EventDescriptorCollectionICustomTypeDescriptor.GetEvents(Attribute[]attributes)
54. {
55. returnTypeDescriptor.GetEvents(this,attributes,true);
56. }
58. PropertyDescriptorCollectionICustomTypeDescriptor.GetProperties()
59. {
60. return((ICustomTypeDescriptor)this).GetProperties(newAttribute[0]);
61. }
63. PropertyDescriptorCollectionICustomTypeDescriptor.GetProperties(Attribute[]attributes)
64. {
65. ArrayListprops=newArrayList();
67. TypethisType=this.GetType();
69. PropertyInfo[]pis=thisType.GetProperties();
70. foreach(PropertyInfopinpis)
71. {
72. if(p.DeclaringType==thisType||p.PropertyType.ToString()=="System.Drawing.Color")
73. {
74. //判断属性是否显示
75. BrowsableAttributeBrowsable=(BrowsableAttribute)Attribute.GetCustomAttribute(p,typeof(BrowsableAttribute));
76. if(Browsable!=null)
77. {
78. if(Browsable.Browsable==true||p.PropertyType.ToString()=="System.Drawing.Color")
79. {
80. PropertyStubpsd=newPropertyStub(p,attributes);
81. props.Add(psd);
82. }
83. }
84. else
85. {
86. PropertyStubpsd=newPropertyStub(p,attributes);
87. props.Add(psd);
88. }
89. }
90. }
92. PropertyDescriptor[]propArray=(PropertyDescriptor[])props.ToArray(typeof(PropertyDescriptor));
93. returnnewPropertyDescriptorCollection(propArray);
94. }
96. objectICustomTypeDescriptor.GetPropertyOwner(PropertyDescriptorpd)
97. {
98. returnthis;
99. }
100. #endregion
102. }
104. ///<summary>
105. ///下面这段代码来源于：http://www.bluespace.cn/Html/Csdn/2_47/View_4702219.html
106. ///</summary>
107. #regionPropertyStub定义
108. publicclassPropertyStub:PropertyDescriptor
109. {
110. PropertyInfoinfo;
112. publicPropertyStub(PropertyInfopropertyInfo,Attribute[]attrs)
113. :base(propertyInfo.Name,attrs)
114. {
115. this.info=propertyInfo;
116. }
118. publicoverrideTypeComponentType
119. {
120. get{returnthis.info.ReflectedType;}
121. }
123. publicoverrideboolIsReadOnly
124. {
125. get{returnthis.info.CanWrite==false;}
126. }
129. publicoverrideTypePropertyType
130. {
131. get{returnthis.info.PropertyType;}
132. }
134. publicoverrideboolCanResetValue(objectcomponent)
135. {
136. returnfalse;
137. }
139. publicoverrideobjectGetValue(objectcomponent)
140. {
141. //Console.WriteLine("GetValue:"+component.GetHashCode());
142. try
143. {
144. returnthis.info.GetValue(component,null);
145. }
146. catch
147. {
148. returnnull;
149. }
150. }
152. publicoverridevoidResetValue(objectcomponent)
153. {
154. }
156. publicoverridevoidSetValue(objectcomponent,objectvalue)
157. {
158. //Console.WriteLine("SetValue:"+component.GetHashCode());
159. this.info.SetValue(component,value,null);
160. }
162. publicoverrideboolShouldSerializeValue(objectcomponent)
163. {
164. returnfalse;
165. }
167. //通过重载下面这个属性，可以将属性在PropertyGrid中的显示设置成中文
168. publicoverridestringDisplayName
169. {
170. get
171. {
172. if(info!=null)
173. {
174. MyControlAttibuteuicontrolattibute=(MyControlAttibute)Attribute.GetCustomAttribute(info,typeof(MyControlAttibute));
175. if(uicontrolattibute!=null)
176. returnuicontrolattibute.PropertyName;
177. else
178. {
179. returninfo.Name;
180. }
181. }
182. else
183. return"";
184. }
185. }
187. }
188. #endregion

修改后的Form界面如下：

Form中由于我仅仅是演示了TextBox所以我就是直接将创建TextBoxProperty对象的代码放在了Control_Click中：

//我这里仅仅做TextBox的属性演示，如果是其它的控件的话，那么你需要设计不同的ControlProperty（比如TextBoxProperty，ComboBoxProperty）

if (sender is TextBox)

{

this.propertyGrid1.SelectedObject = new TextBoxProperty((TextBox)sender);

}

else

{

this.propertyGrid1.SelectedObject = null;

}

对于实际的需要来说应该是根据Control的类型，通过工厂模式来创建ControlProperty。

Form的整个代码如下，窗体如上图所示：

1. //在Form中增加几个Button，分别命名为cmdArrow,cmdLabel,cmdTextBox,cmdComboBox,cmdGroupBox
2. publicpartialclassForm1:Form
3. {
4. privateMouseHook_MouseHook;
5. //我们将所有的已经与具体控件关联了的UISizeKnob缓存在这个HashTable中
6. privateHashtable_HashUISizeKnob;
7. //负责控件移动的类
8. privateHashtable_HashUIMoveKnob;
10. publicForm1()
11. {
12. InitializeComponent();
14. this._MouseHook=newMouseHook(this);
16. this._HashUISizeKnob=newHashtable();
17. this._HashUIMoveKnob=newHashtable();
19. //为了简洁明了，我们在ControlAdded中来设置具体控件和UISizeKnob的关联
20. this.ControlAdded+=newControlEventHandler(Form1_ControlAdded);
21. }
23. voidForm1_ControlAdded(objectsender,ControlEventArgse)
24. {
25. if(!(e.ControlisUISizeDot))
26. {
27. this._HashUISizeKnob.Add(e.Control,newUISizeKnob(e.Control));
28. this._HashUIMoveKnob.Add(e.Control,newUIMoveKnob(e.Control));
30. //点击控件的时候，显示控件的选择
31. e.Control.Click+=newEventHandler(Control_Click);
32. }
33. }
35. voidControl_Click(objectsender,EventArgse)
36. {
37. //寿险清除已经选择的控件
38. foreach(UISizeKnobknobinthis._HashUISizeKnob.Values)
39. {
40. knob.ShowUISizeDots(false);
41. }
42. //System.ComponentModel.Design.ISelectionService
43. //System.Drawing.Design.IToolboxService
44. try
45. {
46. ((UISizeKnob)this._HashUISizeKnob[sender]).ShowUISizeDots(true);
48. //我这里仅仅做TextBox的属性演示，如果是其它的控件的话，那么你需要设计不同的ControlProperty（比如TextBoxProperty，ComboBoxProperty）
49. if(senderisTextBox)
50. {
51. this.propertyGrid1.SelectedObject=newTextBoxProperty((TextBox)sender);
52. }
53. else
54. {
55. this.propertyGrid1.SelectedObject=null;
56. }
57. }
58. catch{}
59. }
61. privatevoidcmdArrow_Click(objectsender,EventArgse)
62. {
63. SettingService.Instance.SelectedToolBoxControl=null;
64. }
66. privatevoidcmdLabel_Click(objectsender,EventArgse)
67. {
68. SettingService.Instance.SelectedToolBoxControl=newLabel();
69. }
71. privatevoidcmdTextBox_Click(objectsender,EventArgse)
72. {
73. SettingService.Instance.SelectedToolBoxControl=newTextBox();
74. }
76. privatevoidcmdComboBox_Click(objectsender,EventArgse)
77. {
78. SettingService.Instance.SelectedToolBoxControl=newComboBox();
79. }
81. privatevoidcmdGroupBox_Click(objectsender,EventArgse)
82. {
83. SettingService.Instance.SelectedToolBoxControl=newGroupBox();
84. }
85. }

好了，让

PropertyGrid 显示中文属性的思路和代码都给了，希望能够给你点启发和帮助。

相关文章：

C#基础系列：开发自己的窗体设计器（总纲）

C#基础系列：开发自己的窗体设计器（在容器上拖动鼠标增加控件）

C#基础系列：开发自己的窗体设计器（实现控件的选择）

C#基础系列：开发自己的窗体设计器（实现控件的拖动）