1. 前言
之前介绍过依赖属性和附加属性的代码段,这两个代码段我用了很多年,一直都帮了我很多。不过这两个代码段我也多年没修改过,Resharper老是提示我生成的代码可以修改,它这么有诚意,这次就只好从了它,顺便简单介绍下怎么自定义代码段。
2. VisualStudio自带代码段的问题
以依赖属性为例,一个完整的依赖属性应该包含以下部分:
-
注册依赖属性并生成依赖属性标识符。依赖属性标识符为一个public static readonly DependencyProperty字段。依赖属性标识符的名称必须为“属性名+Property”。在PropertyMetadata中指定属性默认值。
-
实现属性包装器。为属性提供 get 和 set 访问器,在Getter和Setter中分别调用GetValue和SetValue。Getter和Setter中不应该有其它任何自定义代码。
-
如果需要监视属性值变更,可以在PropertyMetadata中定义一个PropertyChangedCallback方法。因为这个方法是静态的,可以再实现一个同名的实例方法(可以参考ContentControl的OnContentChanged方法)。
public int MyProperty { get { return (int)GetValue(MyPropertyProperty); } set { SetValue(MyPropertyProperty, value); } } // Using a DependencyProperty as the backing store for MyProperty. This enables animation, styling, binding, etc... public static readonly DependencyProperty MyPropertyProperty = DependencyProperty.Register("MyProperty", typeof(int), typeof(ownerclass), new PropertyMetadata(0));如上面代码所示,VisualStudio自带的依赖属性的代码段propdp只实现了最基本的功能,PropertyChangedCallback等函数还得自己实现,而这部分也挺麻烦的。另外,ownerclass基本都是当前类的名字,没有理由不使用当前类的名字作为默认值。
/// <summary> /// 获取或设置MyProperty的值 /// </summary> public int MyProperty { get => (int)GetValue(MyPropertyProperty); set => SetValue(MyPropertyProperty, value); } /// <summary> /// 标识 MyProperty 依赖属性。 /// </summary> public static readonly DependencyProperty MyPropertyProperty = DependencyProperty.Register(nameof(MyProperty), typeof(int), typeof(MainPage), new PropertyMetadata(default(int), OnMyPropertyChanged)); private static void OnMyPropertyChanged(DependencyObject obj, DependencyPropertyChangedEventArgs args) { var oldValue = (int)args.OldValue; var newValue = (int)args.NewValue; if (oldValue == newValue) return; var target = obj as MainPage; target?.OnMyPropertyChanged(oldValue, newValue); } /// <summary> /// MyProperty 属性更改时调用此方法。 /// </summary> /// <param name="oldValue">MyProperty 属性的旧值。</param> /// <param name="newValue">MyProperty 属性的新值。</param> protected virtual void OnMyPropertyChanged(int oldValue, int newValue) { } 上面是我自定义的代码段,改进了这些地方:
- getter和setter使用了表达式主体;
- DependencyProperty.Register的第一个参数使用了
nameof()关键字代替了字符串; - typeof(MainPage)这里使用了代码段函数
ClassName()直接获取当前类的名称;
