带有 MVVM 和依赖属性的 WPF 用户控制地狱

Question

这就是我想要做的：

• 我正在写一个UserControl，我想被其他开发者使用。

• 我希望最终用户能够使用依赖属性来使用我的控件。

  <lib:ControlView ControlsText={Binding Path=UsersOwnViewModelText} />
  

• 我正在使用 MVVM 模式。

• 我正在使用 <DataTemplates> 将我的 ViewModel 绑定到他们的 View 上

  <DataTemplate DataType="{x:Type local:ControlViewModel}">  
      <local:ControlView />  
  </DataTemplate>
  

所以我有两个问题：

1. 如果在 XAML 中使用 UserControl，那么当控件的 Loaded 事件触发而不是使用 <DataTemplate> 方法时，UserControl 必须将 ViewModel 设置为其 DataContext，我的想法是否正确？

2. 如何允许用户将数据绑定到我的控件的依赖属性，同时仍将数据绑定到我的 ViewModel？

Answer 1

您应该将两个用例分开：

1. 其他开发人员将使用的（用户）控件。
2. 您的应用程序将使用的用户控件。

重要的是，后者依赖于前者 - 反之亦然。

用例 1 将使用依赖属性、模板绑定以及制作常规 WPF 控件的所有内容：

MyControl.cs：

public class MyControl : Control
{
    // dependency properties and other logic
}

Generic.xaml：

<ControlTemplate Type="local:MyControl">
    <!-- define the default look in here, using template bindings to bind to your d-props -->
</ControlTemplate>

然后您将用例 2 定义为：

MyViewModel.cs：

public class MyViewModel : ViewModel
{
    // properties and business logic
}

MyView.xaml:

<UserControl ...>
    <local:MyControl SomeProperty="{Binding SomePropertyOnViewModel}" .../>
</UserControl>

两全其美的干净分离。其他开发人员仅依赖于控件，它可能（并且可能应该）位于与您的视图模型和视图完全不同的程序集中。

Answer 2

首先，如果您正在开发将被其他人使用的 UserControl，我认为 MVVM 不是一个好的选择。一个无外观的控件是你真正应该开发的。 Jeremiah Morrill 有一个关于这个主题的blog post。

话虽如此，如果您有默认的公共构造函数，则可以使用 XAML 设置数据上下文。

在 ControlView.xaml 中放置：

<UserControl.DataContext>
    <local:ControlViewModel />
</UserControl.DataContext>

Answer 3

基本上，与其将 UserControl 的 datacontext 绑定到 userControlViewModel，不如在用户控件的第一个子元素上进行绑定。这样，您在控件中所做的所有引用都将绑定到 userControlViewModel，但可以从要使用 UserControl 的数据上下文集中设置依赖项属性。

这是来自我正在从事的一个项目：

<UserControl x:Class="Six_Barca_Main_Interface.MyUserControl"
             xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
             xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
             xmlns:local="clr-namespace:Six_Barca_Main_Interface"
             xmlns:System="clr-namespace:System;assembly=mscorlib" 
             mc:Ignorable="d" 
             d:DesignHeight="900" d:DesignWidth="900">

    <DockPanel  x:Name="rootDock" >
        <TextBlock>{Binding SomethingInMyUserControlViewModel}</TabControl>
    </DockPanel>
</UserControl>

然后是后面的代码：

public partial class MyUserControl : UserControl
{
    UserControlViewModel _vm;

    public MyUserControl()
    {
        InitializeComponent();

        //internal viewModel set to the first child of MyUserControl
         rootDock.DataContext = new UserControlViewModel();

        _vm = (UserControlViewModel)rootDock.DataContext;


        //sets control to be able to use the viewmodel elements

     }

     #region Dependency properties 
     public string textSetFromApplication
     {
         get{return (string)GetValue(textSetFromApplicationProperty);}
         set{SetValue(textSetFromApplicationProperty, value);}
     }

     public static readonly DependencyProperty textSetFromApplicationProperty = DependencyProperty.Register("textSetFromApplication", typeof(string), typeof(MyUserControl), new PropertyMetadata(null, OnDependencyPropertyChanged));

     private static void  OnDependencyPropertyChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
     {
        ((MyUserControl)d)._vm.SomethingInMyUserControlViewModel = 
             e.NewValue as string;
     }
#endregion

然后，当您在主视图上使用它时，您可以使用要传递给 MyUSerControl 的值设置依赖属性

Answer 4

UserControl 是“MVVM”中“视图”的一部分，就像 TextBox 或 ListView 控件是视图的一部分一样。

无论您决定使用 MVVM 来开发您的 UserControl 本身还是用 QBASIC 编写（不推荐）它都不会破坏您 UserControl 的消费者的 MVVM 模式，只要他们可以做他们需要的每一件事通过绑定到DependencyProperty 与您的UserControl 一起暴露在您的UserControl 上。即您的UserControl 应该公开它依赖所依赖的属性（因此得名）。一旦你掌握了这个 DependencyProperty 突然变得很有意义，你希望它们对更改的事件处理程序和你在其构造函数中指定的默认值有所帮助。

如果您的 UserControl 是否在不同的程序集中，我看不出有什么不同。

这就是说，出于 MVVM 带来的所有充分理由，例如帮助其他开发人员查看您的代码。然而，有些事情根本不可能和/或更复杂和性能更低的黑客攻击 XAML 来做到这一点 - 我不是在谈论您的花园品种添加用户表单，而是例如 UserControl 处理数千个视觉效果的布局。此外，由于您在 View 中工作，您确实不希望您的 UserControl 的 ViewModel 与您的应用程序混合！

基本上我的意思是在 MVVM 中不要在视图上使用 MVVM！