快速将类属性公开为可绑定的

本文关键字:绑定 属性 | 更新日期: 2023-09-27 18:19:17

我有一个绑定到视图模型的类。它基本上是一个结构体,充满了UI的可显示字符串:

class DisplayVO
{
    public string Title { get; set; }
    public string Description { get; set; }
    // ... about a dozen more properties 
}

基本上,DisplayVO包装了一堆绑定到UI的属性。这个工作直到UI的一部分修改属性(例如,用户可以编辑Description),所以我想用新的修改来更新UI。

所以我通常会做的是实现INotifyPropertyChanged接口并覆盖每个set方法来广播PropertyChanged(this, new PropertyChangedEventArgs(info));

我觉得很懒——有没有一种方法可以让所有的班级成员都这样做?在Flex中我可以这样做:

[Bindable]
public class DisplayVO
{
    private var Title:String;
    private var Description:String;
}

DisplayVO的所有属性都将被包装以自动广播更改,而无需编写所有样板文件。c#和WPF有等价的吗?

快速将类属性公开为可绑定的

你应该检查一下NotifyPropertyWeaver http://github.com/SimonCropp/NotifyPropertyWeaver它运行一个构建后的任务,这正是你所需要的

您可以编写一个代码片段来填充样板文件。这是一个我使用(我有一个方法,OnPropertyChanged()广播事件:

<?xml version="1.0" encoding="utf-8"?>
<CodeSnippet Format="1.0.0" xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
  <Header>
    <Title>ObservableProperty</Title>
    <Author>Scott Austen</Author>
    <Shortcut>#ObsProp</Shortcut>
    <Description>Inserts property definition with private backing field, calling RaisePropertyChanged</Description>
    <SnippetTypes>
      <SnippetType>Expansion</SnippetType>
    </SnippetTypes>
  </Header>
  <Snippet>
    <Declarations>
      <Literal>
        <ID>Type</ID>
        <Default>Type</Default>
      </Literal>
      <Literal>
        <ID>PropertyName</ID>
        <Default>P</Default>
      </Literal>
    </Declarations>
    <Code Language="CSharp">
      <![CDATA[public $Type$ $PropertyName$
      {
        get { return _$PropertyName$; }
        set
        {
          _$PropertyName$ = value;          
          OnPropertyChanged("$PropertyName$");
        }
      }
      private $Type$ _$PropertyName$;]]>
    </Code>
  </Snippet>
</CodeSnippet>

那么你只需要输入obsprop TAB TAB {type} TAB TAB {propertyName} ENTER.

我使用了一个属性声明片段来调用OnPropertyChanged。它还从系统中填充一些属性。组件模型名称空间…

 Description: a brief phrase about what the property does
 DisplayName: how the property should be labelled 
 DefaultValue: the initial value of the property

这段代码还使用了DebuggerStepThroughAttribute,以便调试器不会输入getter和setter,但是如果你不想要这种效果,应该删除它…

<?xml version="1.0" encoding="utf-8" ?>
<CodeSnippets  xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
    <CodeSnippet Format="1.0.0">
        <Header>
            <Title>Full property declaration</Title>
            <Shortcut>propfull</Shortcut>
            <Description>Code snippet for property and backing field</Description>
            <Author>GJV</Author>
            <SnippetTypes>
                <SnippetType>Expansion</SnippetType>
            </SnippetTypes>
        </Header>
        <Snippet>
            <Declarations>
                <Literal>
                    <ID>type</ID>
                    <ToolTip>Property type</ToolTip>
                    <Default>string</Default>
                </Literal>
                <Literal>
                    <ID>property</ID>
                    <ToolTip>Property name</ToolTip>
                    <Default>MyProperty</Default>
                </Literal>
                <Literal>
                    <ID>field</ID>
            <ToolTip>The variable backing this property</ToolTip>
                    <Default>myProperty</Default>
                </Literal>
                <Literal>
                    <ID>desc</ID>
                    <ToolTip>What the property is about</ToolTip>
                    <Default>My description...</Default>
                </Literal>
                <Literal>
                    <ID>dispname</ID>
                    <ToolTip>Column header</ToolTip>
                    <Default>DisplayName</Default>
                </Literal>
                <Literal>
                    <ID>defaultvalue</ID>
                    <ToolTip>Default value</ToolTip>
                    <Default>""</Default>
                </Literal>
            </Declarations>
            <Code Language="csharp">
        <![CDATA[private $type$ $field$;
    [Description("$desc$"), DisplayName("$dispname$"), DefaultValue($defaultvalue$)]
    public $type$ $property$
    {
            [DebuggerStepThrough]get{return $field$;}
            [DebuggerStepThrough]set
            {
                if(value!=$field$)
                {
                    $field$ = value;
                    OnPropertyChanged("$property$");
                }
            }
    }
    $end$]]>
            </Code>
        </Snippet>
    </CodeSnippet>
</CodeSnippets>

Description属性意味着被提取并用于工具提示文本,但它也可以提供一些文档值。

这个代码片段假设你的基本视图模型类有一个这样的方法…

protected void OnPropertyChanged(string propertyName)
{
    if(PropertyChanged!=null)
    {
        PropertyChanged(this, new PropertyChangedEventArgs(propertyName));
    }
}