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

 

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

如图：

 

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

[Browsable(false)]

public int Width

{

    get { }

    set { }

}

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

 

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

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

下面就是TextBoxProperty的代码：

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

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

1. public class MyControlAttibute : Attribute
2. {
3.     private string _PropertyName;
4.     private string _PropertyDescription;
5.     private object _DefaultValue;
7.     public MyControlAttibute(string Name, string Description, object DefalutValue)
8.     {
9.         this._PropertyName = Name;
10.         this._PropertyDescription = Description;
11.         this._DefaultValue = DefalutValue;
12.     }
14.     public MyControlAttibute(string Name, string Description)
15.     {
16.         this._PropertyName = Name;
17.         this._PropertyDescription = Description;
18.         this._DefaultValue = "";
19.     }
21.     public MyControlAttibute(string Name)
22.     {
23.         this._PropertyName = Name;
24.         this._PropertyDescription = "";
25.         this._DefaultValue = "";
26.     }
28.     public string PropertyName
29.     {
30.         get { return this._PropertyName; }
31.     }
33.     public string PropertyDescription
34.     {
35.         get { return this._PropertyDescription; }
36.     }
38.     public object DefaultValue
39.     {
40.         get { return this._DefaultValue; }
41.     }
42. }

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

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

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

1. public delegate void PropertyChanged(object Value);
3. /// <summary>
4. /// 主要是实现中文化属性显示
5. /// </summary>
6. public class PropertyBase : ICustomTypeDescriptor
7. {
8.     /// <summary>
9.     /// 下面这段代码来源于：http://www.bluespace.cn/Html/Csdn/2_47/View_4702219.html
10.     /// </summary>
11.     /// <returns></returns>
12.     #region ICustomTypeDescriptor 显式接口定义
13.     AttributeCollection ICustomTypeDescriptor.GetAttributes()
14.     {
15.         return TypeDescriptor.GetAttributes(this, true);
16.     }
18.     string ICustomTypeDescriptor.GetClassName()
19.     {
20.         return TypeDescriptor.GetClassName(this, true);
21.     }
23.     string ICustomTypeDescriptor.GetComponentName()
24.     {
25.         return TypeDescriptor.GetComponentName(this, true);
26.     }
28.     TypeConverter ICustomTypeDescriptor.GetConverter()
29.     {
30.         return TypeDescriptor.GetConverter(this, true);
31.     }
33.     EventDescriptor ICustomTypeDescriptor.GetDefaultEvent()
34.     {
35.         return TypeDescriptor.GetDefaultEvent(this, true);
36.     }
38.     PropertyDescriptor ICustomTypeDescriptor.GetDefaultProperty()
39.     {
40.         return null;
41.     }
43.     object ICustomTypeDescriptor.GetEditor(Type editorBaseType)
44.     {
45.         return TypeDescriptor.GetEditor(this, editorBaseType, true);
46.     }
48.     EventDescriptorCollection ICustomTypeDescriptor.GetEvents()
49.     {
50.         return TypeDescriptor.GetEvents(this, true);
51.     }
53.     EventDescriptorCollection ICustomTypeDescriptor.GetEvents(Attribute[] attributes)
54.     {
55.         return TypeDescriptor.GetEvents(this, attributes, true);
56.     }
58.     PropertyDescriptorCollection ICustomTypeDescriptor.GetProperties()
59.     {
60.         return ((ICustomTypeDescriptor)this).GetProperties(new Attribute[0]);
61.     }
63.     PropertyDescriptorCollection ICustomTypeDescriptor.GetProperties(Attribute[] attributes)
64.     {
65.         ArrayList props = new ArrayList();
67.         Type thisType = this.GetType();
69.         PropertyInfo[] pis = thisType.GetProperties();
70.         foreach (PropertyInfo p in pis)
71.         {
72.             if (p.DeclaringType == thisType || p.PropertyType.ToString() == "System.Drawing.Color")
73.             {
74.                 //判断属性是否显示
75.                 BrowsableAttribute Browsable = (BrowsableAttribute)Attribute.GetCustomAttribute(p, typeof(BrowsableAttribute));
76.                 if (Browsable != null)
77.                 {
78.                     if (Browsable.Browsable == true || p.PropertyType.ToString() == "System.Drawing.Color")
79.                     {
80.                         PropertyStub psd = new PropertyStub(p, attributes);
81.                         props.Add(psd);
82.                     }
83.                 }
84.                 else
85.                 {
86.                     PropertyStub psd = new PropertyStub(p, attributes);
87.                     props.Add(psd);
88.                 }
89.             }
90.         }
92.         PropertyDescriptor[] propArray = (PropertyDescriptor[])props.ToArray(typeof(PropertyDescriptor));
93.         return new PropertyDescriptorCollection(propArray);
94.     }
96.     object ICustomTypeDescriptor.GetPropertyOwner(PropertyDescriptor pd)
97.     {
98.         return this;
99.     }
100.     #endregion
102. }
104. /// <summary>
105. /// 下面这段代码来源于：http://www.bluespace.cn/Html/Csdn/2_47/View_4702219.html
106. /// </summary>
107. #region PropertyStub 定义
108. public class PropertyStub : PropertyDescriptor
109. {
110.     PropertyInfo info;
112.     public PropertyStub(PropertyInfo propertyInfo, Attribute[] attrs)
113.         : base(propertyInfo.Name, attrs)
114.     {
115.         this.info = propertyInfo;
116.     }
118.     public override Type ComponentType
119.     {
120.         get { return this.info.ReflectedType; }
121.     }
123.     public override bool IsReadOnly
124.     {
125.         get { return this.info.CanWrite == false; }
126.     }
129.     public override Type PropertyType
130.     {
131.         get { return this.info.PropertyType; }
132.     }
134.     public override bool CanResetValue(object component)
135.     {
136.         return false;
137.     }
139.     public override object GetValue(object component)
140.     {
141.         //Console.WriteLine("GetValue: " + component.GetHashCode());
142.         try
143.         {
144.             return this.info.GetValue(component, null);
145.         }
146.         catch
147.         {
148.             return null;
149.         }
150.     }
152.     public override void ResetValue(object component)
153.     {
154.     }
156.     public override void SetValue(object component, object value)
157.     {
158.         //Console.WriteLine("SetValue: " + component.GetHashCode());
159.         this.info.SetValue(component, value, null);
160.     }
162.     public override bool ShouldSerializeValue(object component)
163.     {
164.         return false;
165.     }
167.     //通过重载下面这个属性，可以将属性在PropertyGrid中的显示设置成中文
168.     public override string DisplayName
169.     {
170.         get
171.         {
172.             if (info != null)
173.             {
174.                 MyControlAttibute uicontrolattibute = (MyControlAttibute)Attribute.GetCustomAttribute(info, typeof(MyControlAttibute));
175.                 if (uicontrolattibute != null)
176.                     return uicontrolattibute.PropertyName;
177.                 else
178.                 {
179.                     return info.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. public partial class Form1 : Form
3. {
4.     private MouseHook _MouseHook;
5.     //我们将所有的已经与具体控件关联了的UISizeKnob缓存在这个HashTable中
6.     private Hashtable _HashUISizeKnob;
7.     //负责控件移动的类
8.     private Hashtable _HashUIMoveKnob;
10.     public Form1()
11.     {
12.         InitializeComponent();
14.         this._MouseHook = new MouseHook(this);
16.         this._HashUISizeKnob = new Hashtable();
17.         this._HashUIMoveKnob = new Hashtable();
19.         //为了简洁明了，我们在ControlAdded中来设置具体控件和UISizeKnob的关联
20.         this.ControlAdded += new ControlEventHandler(Form1_ControlAdded);
21.     }
23.     void Form1_ControlAdded(object sender, ControlEventArgs e)
24.     {
25.         if (!(e.Control is UISizeDot))
26.         {
27.             this._HashUISizeKnob.Add(e.Control, new UISizeKnob(e.Control));
28.             this._HashUIMoveKnob.Add(e.Control, new UIMoveKnob(e.Control));
29.             
30.             //点击控件的时候，显示控件的选择
31.             e.Control.Click += new EventHandler(Control_Click);
32.         }
33.     }
35.     void Control_Click(object sender, EventArgs e)
36.     {
37.         //寿险清除已经选择的控件
38.         foreach (UISizeKnob knob in this._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 (sender is TextBox)
50.         {
51.             this.propertyGrid1.SelectedObject = new TextBoxProperty((TextBox)sender);
52.         }
53.         else
54.         {
55.             this.propertyGrid1.SelectedObject = null;
56.         }
57.         }
58.         catch { }
59.     }
60.     
61.     private void cmdArrow_Click(object sender, EventArgs e)
62.     {
63.         SettingService.Instance.SelectedToolBoxControl = null;
64.     }
66.     private void cmdLabel_Click(object sender, EventArgs e)
67.     {
68.         SettingService.Instance.SelectedToolBoxControl = new Label();
69.     }
71.     private void cmdTextBox_Click(object sender, EventArgs e)
72.     {
73.         SettingService.Instance.SelectedToolBoxControl = new TextBox();
74.     }
76.     private void cmdComboBox_Click(object sender, EventArgs e)
77.     {
78.         SettingService.Instance.SelectedToolBoxControl = new ComboBox();
79.     }
81.     private void cmdGroupBox_Click(object sender, EventArgs e)
82.     {
83.         SettingService.Instance.SelectedToolBoxControl = new GroupBox();
84.     }
85. }

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

 

相关文章：

 

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

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

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

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