WPF 用户控件双向绑定依赖属性答案

【问题标题】：WPF usercontrol Twoway binding Dependency PropertyWPF 用户控件双向绑定依赖属性
【发布时间】：2023-03-26 11:40:01
【问题描述】：

我在用户控件中创建了一个依赖属性，但是用户控件中的更改没有通知给 Viewmodel

用户控件

<UserControl x:Class="DPsample.UserControl1"
         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" 
         d:DesignHeight="300" d:DesignWidth="300">
<Grid>
    <TextBox x:Name="txtName"></TextBox>
</Grid>

UserControl.cs

/// <summary>
/// Interaction logic for UserControl1.xaml
/// </summary>
public partial class UserControl1 : UserControl
{
    public UserControl1()
    {
        InitializeComponent();
    }

    #region SampleProperty 

    public static readonly DependencyProperty SamplePropertyProperty
                                            = DependencyProperty.Register("SampleProperty", 
                                            typeof(string), 
                                            typeof(UserControl1), 
                                            new PropertyMetadata(OnSamplePropertyChanged));


    public string SampleProperty
    {
        get { return (string)GetValue(SamplePropertyProperty); }
        set { SetValue(SamplePropertyProperty, value); }
    }


    static void OnSamplePropertyChanged(DependencyObject obj, DependencyPropertyChangedEventArgs e)
    {
        (obj as UserControl1).OnSamplePropertyChanged(e);
    }
    private void OnSamplePropertyChanged(DependencyPropertyChangedEventArgs e)
    {
        string SamplePropertyNewValue = (string)e.NewValue;

        txtName.Text = SamplePropertyNewValue;
    }

    #endregion
}

主窗口

<Window
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:local="clr-namespace:DPsample" x:Class="DPsample.MainWindow"
    Title="MainWindow" Height="350" Width="525">
<Grid>

    <local:UserControl1 SampleProperty="{Binding SampleText,Mode=TwoWay}" HorizontalAlignment="Left" Margin="76,89,0,0" VerticalAlignment="Top" Width="99"/>
    <Button Content="Show" HorizontalAlignment="Left" Margin="76,125,0,0" VerticalAlignment="Top" Width="75" Click="Button_Click"/>

</Grid>

MainWindow.cs

 public MainWindow()
    {
        InitializeComponent();
        this.DataContext = new MainViewModel();
    }

    private void Button_Click(object sender, RoutedEventArgs e)
    {
        var item = this.DataContext as MainViewModel;
        MessageBox.Show(item.SampleText.ToString());
    }

MainViewModel.cs

public class MainViewModel : NotifyViewModelBase
{
    public MainViewModel()
    {
        this.SampleText = "test";           
    }

    private string _sampleText;
    public string SampleText
    {
        get { return _sampleText; }
        set { _sampleText = value; OnPropertyChanged("SampleText"); }
    }
}

【问题讨论】：

您尚未编写任何将TextBox.Text 属性更改传递给SampleProperty 的代码。您还应该在那里使用绑定，RelativeSource={RelativeSource AncestorType=UserControl}。
@Clemens 我需要为用户控件使用视图模型吗？
在这种情况下不是。但是，UserControl 也可以直接绑定到您的视图模型的SampleText 属性。那么就完全不需要SampleProperty了。

标签： c# wpf user-controls dependency-properties

【解决方案1】：

将 UserControl 中的TextBox.Text 属性绑定到它的SampleProperty，如下所示：

<TextBox Text="{Binding SampleProperty,
                RelativeSource={RelativeSource AncestorType=UserControl}}"/>

现在您可以简单地删除您的 OnSamplePropertyChanged 回调。

你也可以像这样注册SampleProperty来默认绑定双向：

public static readonly DependencyProperty
    SamplePropertyProperty = DependencyProperty.Register(
        "SampleProperty", typeof(string), typeof(UserControl1),
        new FrameworkPropertyMetadata(
            null, FrameworkPropertyMetadataOptions.BindsTwoWayByDefault));

【讨论】：

不敢相信我已经阅读了这么多关于自定义 UserControls 和 DependencyProperties 的教程和示例，但没有人提到解决将值传递回模型的 FrameworkPropertyMetadata。干得好！

【解决方案2】：

另一种方法是使用 ElementName 绑定。先把x:Name属性赋给UserControl（比如x:Name="MyUC"），然后把绑定改成：

<TextBox Text="{Binding ElementName=MyUC, Path=SampleProperty}"/>

【讨论】：