C#控件开发（二）
五、 基础知识：使用Attribute来订制属性窗口的显示
控制显示的机制和用IDL定义的组件是一样的，不过是增加了元数据特性。控制显示使用最普遍的特性是BrowsableAttribute。默认状态下，属性窗口显示对象中定义的所有的公开的、可读的（即public、有get或者set方法的）属性，并且把他们放在“杂项（Misc）”类别中。下面是一个简单的组件例子：
public class SimpleComponent : System.ComponentModel.Component
{
private string data = "(none)";
private bool dataValid = false;
public string Data
{
get
{
return data;
}
set
{
if (value != data)
{
dataValid = true;
data = value;
}
}
}
public bool IsDataValid
{
get
{
// perform some check on the data
//
return dataValid;
}
}
}
下图是这个例子在属性窗口中的显示：
图1.显示在属性窗口中的简单组件
在这个例子中，SimpleComponent有两个属性：Data和IsDataValid。实际上，由于IsDataValid是只读的，因此显示在这里并没有多大意义，设计人员在设计状态没有必要知道这个属性的值。因此，我们给他加上BrowsableAttribute特性让属性窗口不显示他。
[Browsable(false)]
public bool IsDataValid
{
get
{
// perform some check on the data
//
return dataValid;
}
}
编译器会自动在特性类名后添加“Attribute”字符，因此我们可以在代码中省略掉他。当然，输入“[BrowsableAttribute(false)]”是一样的效果。对于那些没有指定特性的属性或者类，编译器都使用默认特性和默认特性值加以描述。在这个例子中，BrowsableAttribute的默认值为true。这个原则对于Visual Basic .NET同样是一致的。两者唯一的区别就是Visual Basic .NET使用尖括号（‘<’和‘>’）来标记特性，而不是在C#中使用的中括号（‘[’和‘]’）。
编译器会自动在特性类名后添加“Attribute”字符，因此我们可以在代码中省略掉他。当然，输入“[BrowsableAttribute(false)]”是一样的效果。对于那些没有指定特性的属性或者类，编译器都使用默认特性和默认特性值加以描述。在这个例子中，BrowsableAttribute的默认值为true。这个原则对于Visual Basic .NET同样是一致的。两者唯一的区别就是Visual Basic .NET使用尖括号（‘<’和‘>’）来标记特性，而不是在C#中使用的中括号（‘[’和‘]’）。
同时，我们注意一下在图1中Data属性的值“abc”是粗体。这意味着属性的值不是默认值，而且这个值在设计器为form或者control生成代码的时候将会保存下来（即会生成一个赋值语句）。而对于属性的默认值就没有必要来生成赋值语句，生成代码意味着增加组件初始化的时间（InitializeComponent方法）和代码文件的大小。那么SimpleComponent该如何将默认值通知属性窗口的呢？要实现这个特性，我们就需要使用DefaultValueAttribute特性对属性加以描述，也就可以在对象的构建器中为属性赋值。当属性窗口显示属性值的时候，它就会比较当前值和DefaultValueAttribute指定的默认值，如果两者不相等的话，就会把值显示成粗体。在下面的例子里，Data属性的值如果不是“(none)”就会被显示成粗体。
[DefaultValue("(none)")]
public string Data
{
// . . .
}
我们同样可以给属性添加更为复杂的判断逻辑而不只是一些简单的固有值的比较，这可以通过给组件增加一些特殊方法加以实现。属性判断逻辑方法的名字必须以“ShouldSerialize”开头，并且接着就是属性的名字，而且此方法的返回值为“Boolean”。在这个例子里，这种方法就叫“ShouldSerializeData”。在SimpleComponent组件中增加下面的代码就可以实现和DefaultValueAttribute同样的效果，不过他却可以有更强的逻辑代码。
private bool ShouldSerializeData()
{
return Data != "(none)";
}
一般来说，将属性分类对设计者来说界面更加友好。我们就是用CategoryAttribute特性来给属性分类。这个特性就使用一个简单的类目字符串，属性窗口可以据此将属性显示在类目的子项中。类目名称可以自行决定。
[DefaultValue("(none)"), Category("Sample")]
public string Data
{
// . . .
}
组件开发者经常遇到的一个问题就是如何实现这个类目字符串的本地化。我们看看CategoryAttribute类，就可以看到他的GetLocalizedString方法就提供了这样的功能。要实现类目字符串的本地化，就要从CategoryAttribute类派生新的特性类。在这个例子里，我们从组件的字串资源中得到以键值为索引的本地化的类目字符串。在指定属性的CategoryAttribute特性时，用这个键值（Key）替换原来的类目名作为输入参数。这样属性窗在查询属性的CategoryAttribute就会调用GetLocalizedString方法并且把key值作为参数传入方法，在属性窗口中显示返回属性的类目名称。
internal class LocCategoryAttribute : CategoryAttribute
{
public LocCategoryAttribute(string categoryKey) : base(categoryKey)
{
}
protected override string GetLocalizedString(string key)
{
// get the resource set for the current locale.
//
ResourceManager resourceManager = new ResourceManager();
string categoryName = null;
// walk up the cultures until we find one with
// this key as a resource as our category name
// if we reach the invariant culture, quit.
//
for (CultureInfo culture = CultureInfo.CurrentCulture;
categoryName == null &&
culture != CultureInfo.InvariantCulture;
culture = culture.Parent)
{
categoryName = (string)resourceManager.GetObject(key, culture);
}
return categoryName;
}
}
使用这个本地化类目名称，我们要先定义一个包含有这个key的资源文件，并且把这个特性使用到属性上去。
[LocCategory("SampleKey")]
public string Data
{
// . . .
}
当我们在设计窗口的时候，如果选择了Form上的多个组件，属性窗口就会显示他们共同属性，共同属性是按组件的属性名和类型区别的。如果改变共同属性的值，那么所有的被选择的组件的这个属性值都会跟着改变。而把一个属性包括在和其他属性的合成里一般来说意义不大。通常，共同属性都是有唯一的值，比如另一个组件的名字。由于当选择了多个组件的时候，改变共同属性的值，所有的被选择组件的对应属性值都会改变，因此，需要指定某些属性不被合并为共同属性。MergablePropertyAttribute就可以做到这点。只要简单的把这个特性参数设为false值，就可以在选择多个组件的时候隐藏掉这个属性，自然他的值就不会跟着变化了。
一些属性的值可以影响到另外的一些属性值。例如，在实现数据绑定的组件中，清除掉DataSource的值，当然应该清除掉DataMember的值。RefreshPropertiesAttribute就让我们实现这个功能。他的默认参数是“none,”也就是不影响到其他属性，如果指定其他的特性参数，属性窗口就可以在改变这个属性值的同时，自动的更新其他属性的值。另外的两个值，其一是Repaint，它让属性窗口重新获取属性的值并且重画他们；还有就是All，它就意味着组件自己要重新获取属性的值。如果值的改变导致属性的数目的增减，那么我们就要使用All。不过要注意到这个一般用在高级场合，并且速度要比Repaint慢。RefreshProperties.Repaint适用于大部分的情况。需要注意的是，这个特性是用在引发改变的属性上，而不是被改编的属性上。
最后，DefaultPropertyAttribute和DefaultEventAttribute使用在类级别的场合，他们让属性窗口高亮显示这些属性和事件。当选择其他的组件的时候，属性窗口总是试图定位到和上次选择的组件相同的属性或事件上。如果没有找到这样的属性或事件的话，它就会将输入指针定位到DefaultPropertyAttribute指定的属性。在Event视图就会定位到DefaultEventAttribute指定的事件。同时，这个事件也是当你双击组件时，自动使用的事件。
控制显示的机制和用IDL定义的组件是一样的，不过是增加了元数据特性。控制显示使用最普遍的特性是BrowsableAttribute。默认状态下，属性窗口显示对象中定义的所有的公开的、可读的（即public、有get或者set方法的）属性，并且把他们放在“杂项（Misc）”类别中。下面是一个简单的组件例子：
public class SimpleComponent : System.ComponentModel.Component
{
private string data = "(none)";
private bool dataValid = false;
public string Data
{
get
{
return data;
}
set
{
if (value != data)
{
dataValid = true;
data = value;
}
}
}
public bool IsDataValid
{
get
{
// perform some check on the data
//
return dataValid;
}
}
}
下图是这个例子在属性窗口中的显示：
图1.显示在属性窗口中的简单组件
在这个例子中，SimpleComponent有两个属性：Data和IsDataValid。实际上，由于IsDataValid是只读的，因此显示在这里并没有多大意义，设计人员在设计状态没有必要知道这个属性的值。因此，我们给他加上BrowsableAttribute特性让属性窗口不显示他。
[Browsable(false)]
public bool IsDataValid
{
get
{
// perform some check on the data
//
return dataValid;
}
}
编译器会自动在特性类名后添加“Attribute”字符，因此我们可以在代码中省略掉他。当然，输入“[BrowsableAttribute(false)]”是一样的效果。对于那些没有指定特性的属性或者类，编译器都使用默认特性和默认特性值加以描述。在这个例子中，BrowsableAttribute的默认值为true。这个原则对于Visual Basic .NET同样是一致的。两者唯一的区别就是Visual Basic .NET使用尖括号（‘<’和‘>’）来标记特性，而不是在C#中使用的中括号（‘[’和‘]’）。
编译器会自动在特性类名后添加“Attribute”字符，因此我们可以在代码中省略掉他。当然，输入“[BrowsableAttribute(false)]”是一样的效果。对于那些没有指定特性的属性或者类，编译器都使用默认特性和默认特性值加以描述。在这个例子中，BrowsableAttribute的默认值为true。这个原则对于Visual Basic .NET同样是一致的。两者唯一的区别就是Visual Basic .NET使用尖括号（‘<’和‘>’）来标记特性，而不是在C#中使用的中括号（‘[’和‘]’）。
同时，我们注意一下在图1中Data属性的值“abc”是粗体。这意味着属性的值不是默认值，而且这个值在设计器为form或者control生成代码的时候将会保存下来（即会生成一个赋值语句）。而对于属性的默认值就没有必要来生成赋值语句，生成代码意味着增加组件初始化的时间（InitializeComponent方法）和代码文件的大小。那么SimpleComponent该如何将默认值通知属性窗口的呢？要实现这个特性，我们就需要使用DefaultValueAttribute特性对属性加以描述，也就可以在对象的构建器中为属性赋值。当属性窗口显示属性值的时候，它就会比较当前值和DefaultValueAttribute指定的默认值，如果两者不相等的话，就会把值显示成粗体。在下面的例子里，Data属性的值如果不是“(none)”就会被显示成粗体。
[DefaultValue("(none)")]
public string Data
{
// . . .
}
我们同样可以给属性添加更为复杂的判断逻辑而不只是一些简单的固有值的比较，这可以通过给组件增加一些特殊方法加以实现。属性判断逻辑方法的名字必须以“ShouldSerialize”开头，并且接着就是属性的名字，而且此方法的返回值为“Boolean”。在这个例子里，这种方法就叫“ShouldSerializeData”。在SimpleComponent组件中增加下面的代码就可以实现和DefaultValueAttribute同样的效果，不过他却可以有更强的逻辑代码。
private bool ShouldSerializeData()
{
return Data != "(none)";
}
一般来说，将属性分类对设计者来说界面更加友好。我们就是用CategoryAttribute特性来给属性分类。这个特性就使用一个简单的类目字符串，属性窗口可以据此将属性显示在类目的子项中。类目名称可以自行决定。
[DefaultValue("(none)"), Category("Sample")]
public string Data
{
// . . .
}
组件开发者经常遇到的一个问题就是如何实现这个类目字符串的本地化。我们看看CategoryAttribute类，就可以看到他的GetLocalizedString方法就提供了这样的功能。要实现类目字符串的本地化，就要从CategoryAttribute类派生新的特性类。在这个例子里，我们从组件的字串资源中得到以键值为索引的本地化的类目字符串。在指定属性的CategoryAttribute特性时，用这个键值（Key）替换原来的类目名作为输入参数。这样属性窗在查询属性的CategoryAttribute就会调用GetLocalizedString方法并且把key值作为参数传入方法，在属性窗口中显示返回属性的类目名称。
internal class LocCategoryAttribute : CategoryAttribute
{
public LocCategoryAttribute(string categoryKey) : base(categoryKey)
{
}
protected override string GetLocalizedString(string key)
{
// get the resource set for the current locale.
//
ResourceManager resourceManager = new ResourceManager();
string categoryName = null;
// walk up the cultures until we find one with
// this key as a resource as our category name
// if we reach the invariant culture, quit.
//
for (CultureInfo culture = CultureInfo.CurrentCulture;
categoryName == null &&
culture != CultureInfo.InvariantCulture;
culture = culture.Parent)
{
categoryName = (string)resourceManager.GetObject(key, culture);
}
return categoryName;
}
}
使用这个本地化类目名称，我们要先定义一个包含有这个key的资源文件，并且把这个特性使用到属性上去。
[LocCategory("SampleKey")]
public string Data
{
// . . .
}
当我们在设计窗口的时候，如果选择了Form上的多个组件，属性窗口就会显示他们共同属性，共同属性是按组件的属性名和类型区别的。如果改变共同属性的值，那么所有的被选择的组件的这个属性值都会跟着改变。而把一个属性包括在和其他属性的合成里一般来说意义不大。通常，共同属性都是有唯一的值，比如另一个组件的名字。由于当选择了多个组件的时候，改变共同属性的值，所有的被选择组件的对应属性值都会改变，因此，需要指定某些属性不被合并为共同属性。MergablePropertyAttribute就可以做到这点。只要简单的把这个特性参数设为false值，就可以在选择多个组件的时候隐藏掉这个属性，自然他的值就不会跟着变化了。
一些属性的值可以影响到另外的一些属性值。例如，在实现数据绑定的组件中，清除掉DataSource的值，当然应该清除掉DataMember的值。RefreshPropertiesAttribute就让我们实现这个功能。他的默认参数是“none,”也就是不影响到其他属性，如果指定其他的特性参数，属性窗口就可以在改变这个属性值的同时，自动的更新其他属性的值。另外的两个值，其一是Repaint，它让属性窗口重新获取属性的值并且重画他们；还有就是All，它就意味着组件自己要重新获取属性的值。如果值的改变导致属性的数目的增减，那么我们就要使用All。不过要注意到这个一般用在高级场合，并且速度要比Repaint慢。RefreshProperties.Repaint适用于大部分的情况。需要注意的是，这个特性是用在引发改变的属性上，而不是被改编的属性上。
最后，DefaultPropertyAttribute和DefaultEventAttribute使用在类级别的场合，他们让属性窗口高亮显示这些属性和事件。当选择其他的组件的时候，属性窗口总是试图定位到和上次选择的组件相同的属性或事件上。如果没有找到这样的属性或事件的话，它就会将输入指针定位到DefaultPropertyAttribute指定的属性。在Event视图就会定位到DefaultEventAttribute指定的事件。同时，这个事件也是当你双击组件时，自动使用的事件。
