如何绑定到 WPF 中 UserControl 的属性？

Question

我正在尝试绑定到用户控件的属性，但它似乎不起作用。

<Controls:BasicFilter Title="Some title" FilterLists="{Binding LocationFilterLists}"/>

FilterLists 是我要绑定的属性。 Title 属性包含一个文本，该文本显示在我的控件内的标签上，效果很好。

我已经设置了一个基本的 ViewModel，它尝试设置 LocationFilterLists。因为它绑定到我的控件的FilterLists 属性，所以我希望这会将该值设置为该属性，但这不会发生。这是我的 ViewModel 的代码：

public class MainViewModel : DependencyObject
{
 public NamedListList LocationFilterLists
 {
  get { return (NamedListList)GetValue(LocationFilterListsProperty); }
  set { SetValue(LocationFilterListsProperty, value); }
 }
 public static readonly DependencyProperty LocationFilterListsProperty =
     DependencyProperty.Register("LocationFilterLists", typeof(NamedListList), typeof(MainViewModel), new PropertyMetadata(null));

 public MainViewModel()
 {
 }

 internal void Refresh()
 {
  NamedListList nll = new NamedListList();
  NamedList nl1 = new NamedList();
  nl1.Name = "filter1";
  NamedList nl2 = new NamedList();
  nl2.Name = "filter2";
  nll.Add(nl1);
  nll.Add(nl2);
  LocationFilterLists = nll;
 }
}

NamedList 继承自 List<object> 并添加了属性 Name，NamedListList 继承自 List<NamedList>。我已将视图设置为在 DataContext 设置为此 ViewModel 后立即调用 Refresh 方法。

这是我的控件的 XAML：

<UserControl x:Class="Plin.CommonDisplayObjects.Controls.BasicFilter"
             xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
             xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
             xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" 
             xmlns:d="http://schemas.microsoft.com/expression/blend/2008" 
             mc:Ignorable="d">
 <Grid Background="Gray">
  <DockPanel x:Name="dockPanel" Margin="3">
   <Label Content="{Binding Title}" DockPanel.Dock="Top" Margin="0" Padding="5,3,5,3"/>
  </DockPanel>
 </Grid>
</UserControl>

这是我的控件的代码隐藏：

public partial class BasicFilter : UserControl
{
 #region Dependency Properties
 public string Title
 {
  get { return (string)GetValue(TitleProperty); }
  set { SetValue(TitleProperty, value); }
 }
 public static readonly DependencyProperty TitleProperty =
     DependencyProperty.Register("Title", typeof(string), typeof(BasicFilter), new PropertyMetadata(""));

 public NamedListList FilterLists
 {
  get { return (NamedListList)GetValue(FilterListsProperty); }
  set
  {
   SetValue(FilterListsProperty, value);
   RegenerateFilter(); // Every time property is set, new buttons should be generated.
  }
 }
 public static readonly DependencyProperty FilterListsProperty =
     DependencyProperty.Register("FilterLists", typeof(NamedListList), typeof(BasicFilter), new PropertyMetadata(null));
 #endregion

 public BasicFilter()
 {
  InitializeComponent();
  this.DataContext = this;
 }

 private void RegenerateFilter()
 {
  dockPanel.Children.Clear();
  if (FilterLists != null)
  {
   foreach (NamedList nl in FilterLists)
   {
    Button b = new Button();
    b.Content = "Some generic content " + nl.Name;
    // set other properties on Button
    dockPanel.Children.Add(b);
   }
  }
 }
}

在启动时，我的控件上应该出现两个按钮，但在这种情况下没有出现。我尝试以编程方式设置FilterLists 属性（通过将视图引用传递给ViewModel，命名我的控件和viewReference.myControl.FilterLists = nll;）并且这可行，但我希望能够如上所示进行绑定。我错过了什么？

Answer 1

除了依赖属性的 CLR 包装器中的 SetValue 之外，您不应该做任何事情，因为 WPF 可能会绕过包装器。有关详细信息，请参阅 MSDN 上的XAML Loading and Dependency Properties 文章。

您必须使用依赖属性元数据注册一个 PropertyChangedCallback，而不是在 setter 中调用 RegenerateFilter()：

public NamedListList FilterLists
{
    get { return (NamedListList)GetValue(FilterListsProperty); }
    set { SetValue(FilterListsProperty, value); }
}

public static readonly DependencyProperty FilterListsProperty =
    DependencyProperty.Register(
        "FilterLists", typeof(NamedListList), typeof(BasicFilter),
        new PropertyMetadata(null, FilterListsPropertyChanged));

private static void FilterListsPropertyChanged(
    DependencyObject o, DependencyPropertyChangedEventArgs e)
{
    ((BasicFilter)o).RegenerateFilter();
}

---

也就是说，您的视图模型不应该从 DependencyObject 派生并声明依赖属性。相反，它应该实现INotifyPropertyChanged 接口，并在必须通知集合更改时使用 ObservableCollections。

---

编辑：由于 BasicFilter 构造函数中的语句this.DataContext = this;，UserControl 的 DataContext 设置为它自己，而不是任何视图模型实例。因此，绑定基础结构会在 UserControl 中搜索绑定源属性 LocationFilterLists，而这当然不存在。

从 BasicFilter 构造函数中删除该行，并让 UserControl 从其父控件（自动工作）继承其 DataContext。这假设例如的 DataContext MainWindow 被设置为 MainViewModel 的一个实例。