绑定到 ObservableCollection 的 ItemsControl 在 属性 更改时未更新 UI

ItemsControl bound to ObservableColellection not updating UI on property change

在经历了很多头痛和深夜之后,我放弃了尝试自己解决这个答案的问题。虽然可以找到很多关于非常相似问题的文献,但我无法找到针对我的特定问题的确切解决方案。

我在使用 canvas 作为 ItemsPanel 更新 UI 后,在其 ItemsSource 中的某个项目的 属性 已被修改后,我无法获取 ItemsControl。

我创建了一个非常干净的示例应用程序来演示到​​底发生了什么。

在我的示例应用程序中,我有一个视图 'MainWindow.xaml'、一个继承 'ViewModelBase.vb' 的视图模型 'MainWindowViewModel.vb',最后是一个命令委托 'DelegateCommand.vb',用于创建 RelayCommands 以更新我的 ItemsControl 的 ItemSource。

首先,MainWindow.xaml:

<Window
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:local="clr-namespace:SampleApp"
    x:Class="MainWindow" Title="MainWindow" Height="347" Width="525" Background="Black">
    <Window.DataContext>
        <local:MainWindowViewModel/>
    </Window.DataContext>
    <Grid>
        <!-- LINE SEGMENTS -->
        <ItemsControl x:Name="ic1" ItemsSource="{Binding LineData, Mode=OneWay, NotifyOnTargetUpdated=True}" HorizontalAlignment="Left" Height="246" VerticalAlignment="Top" Width="517" Background="#FF191919" BorderBrush="#FF444444">
            <ItemsControl.ItemsPanel>
                <ItemsPanelTemplate>
                    <Canvas IsItemsHost="True"/>
                </ItemsPanelTemplate>
            </ItemsControl.ItemsPanel>
            <ItemsControl.ItemTemplate>
                <DataTemplate>
                    <Line X1="{Binding X1}" Y1="{Binding Y1}" X2="{Binding X2}" Y2="{Binding Y2}" Stroke="White" StrokeThickness="6"/>
                </DataTemplate>
            </ItemsControl.ItemTemplate>
        </ItemsControl>

        <Button Content="Refresh Canvas" HorizontalAlignment="Left" Margin="350,261,0,0" VerticalAlignment="Top" Width="124" Height="40" FontFamily="Verdana" FontWeight="Bold" Click="Button_Click"/>
        <Button Content="Command 1" Command="{Binding Command1}" HorizontalAlignment="Left" Margin="45,261,0,0" VerticalAlignment="Top" Width="124" Height="40" FontFamily="Verdana" FontWeight="Bold"/>
        <Button Content="Command 2" Command="{Binding Command2}" HorizontalAlignment="Left" Margin="198,261,0,0" VerticalAlignment="Top" Width="124" Height="40" FontWeight="Bold" FontFamily="Verdana"/>
    </Grid>
</Window>

如您所见,我的 Window 的 DataContext 是 MainWindowViewModel,ItemSource 的绑定是 LineData(位于该 VM 中)。

此外,我还有三个按钮。前两个按钮执行 ICommands,而第三个按钮执行 ItemsControl 的后台代码刷新(这是出于调试目的,以证明在 UI 时更新 ItemSource 中的绑定 属性不是)。稍后会详细介绍。

第一个按钮绑定到VM中的Command1,而第二个按钮绑定到VM中的Command2。

接下来,MainWindowViewModel.vb:

Imports System.Collections.ObjectModel

Public Class MainWindowViewModel
    Inherits ViewModelBase

    ' Sample line data variable
    Private _LineData As ObservableCollection(Of LineStructure) = GetLineData()
    Public Property LineData As ObservableCollection(Of LineStructure)
        Get
            Return _LineData
        End Get
        Set(value As ObservableCollection(Of LineStructure))
            _LineData = value
            OnPropertyChanged("LineData")
        End Set
    End Property

    ' ICommands
    Private _Command1 As ICommand
    Public ReadOnly Property Command1 As ICommand
        Get
            If _Command1 Is Nothing Then
                _Command1 = New MVVM.RelayCommand(AddressOf ExecuteCommand1)
            End If
            Return _Command1
        End Get
    End Property

    Private _Command2 As ICommand
    Public ReadOnly Property Command2 As ICommand
        Get
            If _Command2 Is Nothing Then
                _Command2 = New MVVM.RelayCommand(AddressOf ExecuteCommand2)
            End If
            Return _Command2
        End Get
    End Property

    ' ICommand Methods
    Private Sub ExecuteCommand1()
        ' Re-arrange LineData(0) to make a plus sign on the canvas
        ' This works - Assigning a new value to an item of the collection updates the canvas
        LineData(0) = New LineStructure With {.X1 = "175", .Y1 = "50", .X2 = "175", .Y2 = "150"}
    End Sub

    Private Sub ExecuteCommand2()
        ' Put LineData(0) back into its original position
        ' This doesn't work - Modifying the PROPERTY of an item in the collection does not update the canvas.. even with INotifyPropertyChange being called
        LineData(0).X1 = "50"
        LineData(0).Y1 = "50"
        LineData(0).X2 = "300"
        LineData(0).Y2 = "50"

        OnPropertyChanged("LineData")
    End Sub

    ' Misc methods
    Private Function GetLineData() As ObservableCollection(Of LineStructure)
        Dim tmpList As New ObservableCollection(Of LineStructure)

        ' Create two horizontal parallel lines
        tmpList.Add(New LineStructure With {.X1 = "50", .Y1 = "50", .X2 = "300", .Y2 = "50"})
        tmpList.Add(New LineStructure With {.X1 = "50", .Y1 = "100", .X2 = "300", .Y2 = "100"})

        Return tmpList
    End Function
End Class

Public Class LineStructure
    Public Property X1
    Public Property Y1
    Public Property X2
    Public Property Y2
End Class

在我的视图模型中,我已经立即定义了 LineData(这是我的 ItemsSource 绑定到的),所以我们有一些 ItemSource 的数据准备好在执行时显示在 canvas 中。它由 GetLineData() 函数定义,它只是 returns 一个填充的 2 行 ObservableCollection。

应用程序首次启动时,会显示两条平行的水平线。

LineData 变量是我定义的 LineStructure class 的一个 ObservableObject,它仅包含 X1、Y1、X2、Y2 字符串,供各个对象绑定并显示在 canvas.

Command1(同样,它绑定到第一个按钮)将新的 LineStructure 分配给 LineData 的第一个索引。执行此操作后,一切都很棒; UI 按预期更新,每个人都很高兴。这使得这些行在 canvas.

上显示为加号

这里是问题开始的地方:

Command2 不会像 Command1 那样将新的 LineStructure 分配给第一个 LineData 索引,而是将单独重新定义第一个 LineData 索引中的属性。如果这行得通,它会重新排列第一行,canvas 上的两行将再次水平平行。

然而,这不会更新 canvas/UI - 我不明白为什么。我已经阅读了很多文章并尝试了很多不同的解决方案都无济于事。

如果有人能解释为什么绑定在修改 属性 时不更新,而不是一起重新声明 LineStructure 索引,请告诉我,我将不胜感激。

最后要注意的一件事,我已经设法找到了一个解决方案,可以完成我需要完成的工作,但是我认为我不应该必须使用它..我认为绑定应该能够接受注意检测任何 属性 变化。

对于任何感兴趣的人,请参阅以下代码片段,了解在 属性 更改时更新 canvas 的临时解决方案。

我在 xaml.

中的 ItemsControl 声明中添加了 NotifyOnTargetUpdated=True 和 TargetUpdated="RefreshCanvas"

它所做的是调用一个名为 RefreshCanvas() 的方法,该方法从 MainWindow 的代码隐藏中执行 ic1.Items.Refresh()(您可以在最后找到代码隐藏post)。这会刷新 ItemsControl 项目,因此 canvas 会刷新并显示对绑定集合的更新。

<ItemsControl x:Name="ic1" TargetUpdated="RefreshCanvas" ItemsSource="{Binding LineData, Mode=OneWay, UpdateSourceTrigger=PropertyChanged, NotifyOnTargetUpdated=True}" HorizontalAlignment="Left" Height="246" VerticalAlignment="Top" Width="517" Background="#FF191919" BorderBrush="#FF444444">

我将包括我的其他文件仅供参考,因为它可能是相关的:

ViewModelBase.vb:

Imports System.ComponentModel

Public MustInherit Class ViewModelBase
    Implements INotifyPropertyChanged, IDisposable

#Region "Constructor"
    Protected Sub New()
    End Sub
#End Region ' Constructor

#Region "DisplayName"

    ' Returns the user-friendly name of this object.
    ' Child classes can set this property to a new value, or override it to determine the value on-demand.

    Private privateDisplayName As String

    Public Overridable Property DisplayName() As String
        Get
            Return privateDisplayName
        End Get
        Protected Set(ByVal value As String)
            privateDisplayName = value
        End Set
    End Property
#End Region ' DisplayName

#Region "Debugging Aids"
    ' Warns the developer if this object does not have a public property with the specified name. 
    ' This method does not exist in a Release build.
    <Conditional("DEBUG"), DebuggerStepThrough()> _
    Public Sub VerifyPropertyName(ByVal propertyName As String)
        ' Verify that the property name matches a real, public, instance property on this object.
        If TypeDescriptor.GetProperties(Me)(propertyName) Is Nothing Then
            Dim msg As String = "Invalid property name: " & propertyName

            If Me.ThrowOnInvalidPropertyName Then
                Throw New Exception(msg)
            Else
                Debug.Fail(msg)
            End If
        End If
    End Sub

    ' Returns whether an exception is thrown, or if a Debug.Fail() is used when an invalid property name is passed to the VerifyPropertyName method.
    ' The default value is false, but subclasses used by unit tests might override this property's getter to return true.
    Private privateThrowOnInvalidPropertyName As Boolean
    Protected Overridable Property ThrowOnInvalidPropertyName() As Boolean
        Get
            Return privateThrowOnInvalidPropertyName
        End Get
        Set(ByVal value As Boolean)
            privateThrowOnInvalidPropertyName = value
        End Set
    End Property
#End Region ' Debugging Aides

#Region "INotifyPropertyChanged Members"
    ' Raised when a property on this object has a new value.
    Public Event PropertyChanged As PropertyChangedEventHandler Implements INotifyPropertyChanged.PropertyChanged

    ' Raises this object's PropertyChanged event.
    ' <param name="propertyName">The property that has a new value.</param>
    Protected Overridable Sub OnPropertyChanged(ByVal propertyName As String)
        Me.VerifyPropertyName(propertyName)

        Dim handler As PropertyChangedEventHandler = Me.PropertyChangedEvent
        If handler IsNot Nothing Then
            Dim e = New PropertyChangedEventArgs(propertyName)
            handler(Me, e)
        End If
    End Sub
#End Region ' INotifyPropertyChanged Members

#Region "IDisposable Support"
    Private disposedValue As Boolean ' To detect redundant calls

    ' IDisposable
    Protected Overridable Sub Dispose(disposing As Boolean)
        If Not Me.disposedValue Then
            If disposing Then
                ' TODO: dispose managed state (managed objects).
            End If

            ' TODO: free unmanaged resources (unmanaged objects) and override Finalize() below.
            ' TODO: set large fields to null.
        End If
        Me.disposedValue = True
    End Sub

    ' Invoked when this object is being removed from the application and will be subject to garbage collection.
    Public Sub Dispose() Implements IDisposable.Dispose
        Me.OnDispose()
    End Sub

    ' Child classes can override this method to perform clean-up logic, such as removing event handlers.
    Protected Overridable Sub OnDispose()
    End Sub

    ' Controla el tancament del ViewModel.
    ' <returns></returns>
    ' <remarks></remarks>
    Public Overridable Function CanClose() As Boolean
        Return Nothing
    End Function

#If DEBUG Then
    ' Useful for ensuring that ViewModel objects are properly garbage collected.
    Protected Overrides Sub Finalize()
        Dim msg As String = String.Format("{0} ({1}) ({2}) Finalized", Me.GetType().Name, Me.DisplayName, Me.GetHashCode())
        System.Diagnostics.Debug.WriteLine(msg)
    End Sub
#End If
#End Region

End Class

DelegateCommand.vb:

Imports System.Windows.Input

Namespace MVVM
    Public NotInheritable Class RelayCommand
        Implements ICommand

#Region " Declarations "
        Private ReadOnly _objCanExecuteMethod As Predicate(Of Object) = Nothing
        Private ReadOnly _objExecuteMethod As Action(Of Object) = Nothing
#End Region

#Region " Events "
        Public Custom Event CanExecuteChanged As EventHandler Implements System.Windows.Input.ICommand.CanExecuteChanged
            AddHandler(ByVal value As EventHandler)
                If _objCanExecuteMethod IsNot Nothing Then
                    AddHandler CommandManager.RequerySuggested, value
                End If
            End AddHandler

            RemoveHandler(ByVal value As EventHandler)
                If _objCanExecuteMethod IsNot Nothing Then
                    RemoveHandler CommandManager.RequerySuggested, value
                End If
            End RemoveHandler

            RaiseEvent(ByVal sender As Object, ByVal e As System.EventArgs)
                If _objCanExecuteMethod IsNot Nothing Then
                    CommandManager.InvalidateRequerySuggested()
                End If
            End RaiseEvent
        End Event
#End Region

#Region " Constructor "
        Public Sub New(ByVal objExecuteMethod As Action(Of Object))
            Me.New(objExecuteMethod, Nothing)
        End Sub

        Public Sub New(ByVal objExecuteMethod As Action(Of Object), ByVal objCanExecuteMethod As Predicate(Of Object))
            If objExecuteMethod Is Nothing Then
                Throw New ArgumentNullException("objExecuteMethod", "Delegate comamnds can not be null")
            End If

            _objExecuteMethod = objExecuteMethod
            _objCanExecuteMethod = objCanExecuteMethod
        End Sub
#End Region

#Region " Methods "
        Public Function CanExecute(ByVal parameter As Object) As Boolean Implements System.Windows.Input.ICommand.CanExecute
            If _objCanExecuteMethod Is Nothing Then
                Return True
            Else
                Return _objCanExecuteMethod(parameter)
            End If
        End Function

        Public Sub Execute(ByVal parameter As Object) Implements System.Windows.Input.ICommand.Execute
            If _objExecuteMethod Is Nothing Then
                Return
            Else
                _objExecuteMethod(parameter)
            End If
        End Sub
#End Region
    End Class
End Namespace


Namespace MVVM
    Public NotInheritable Class RelayCommand(Of T)
        Implements ICommand

#Region " Declarations "
        Private ReadOnly _objCanExecuteMethod As Predicate(Of T) = Nothing
        Private ReadOnly _objExecuteMethod As Action(Of T) = Nothing
#End Region

#Region " Events "
        Public Custom Event CanExecuteChanged As EventHandler Implements System.Windows.Input.ICommand.CanExecuteChanged
            AddHandler(ByVal value As EventHandler)
                If _objCanExecuteMethod IsNot Nothing Then
                    AddHandler CommandManager.RequerySuggested, value
                End If
            End AddHandler

            RemoveHandler(ByVal value As EventHandler)
                If _objCanExecuteMethod IsNot Nothing Then
                    RemoveHandler CommandManager.RequerySuggested, value
                End If
            End RemoveHandler

            RaiseEvent(ByVal sender As Object, ByVal e As System.EventArgs)
                If _objCanExecuteMethod IsNot Nothing Then
                    CommandManager.InvalidateRequerySuggested()
                End If
            End RaiseEvent
        End Event
#End Region

#Region " Constructors "
        Public Sub New(ByVal objExecuteMethod As Action(Of T))
            Me.New(objExecuteMethod, Nothing)
        End Sub

        Public Sub New(ByVal objExecuteMethod As Action(Of T), ByVal objCanExecuteMethod As Predicate(Of T))
            If objExecuteMethod Is Nothing Then
                Throw New ArgumentNullException("objExecuteMethod", "Delegate comamnds can not be null")
            End If

            _objExecuteMethod = objExecuteMethod
            _objCanExecuteMethod = objCanExecuteMethod
        End Sub
#End Region

#Region " Methods "
        Public Function CanExecute(ByVal parameter As Object) As Boolean Implements ICommand.CanExecute
            If _objCanExecuteMethod Is Nothing Then
                Return True
            Else
                Return _objCanExecuteMethod(DirectCast(parameter, T))
            End If
        End Function

        Public Sub Execute(ByVal parameter As Object) Implements ICommand.Execute
            _objExecuteMethod(DirectCast(parameter, T))
        End Sub
#End Region
    End Class
End Namespace

MainWindow.xaml.vb(MainWindow 的代码隐藏):

Class MainWindow 
    Private Sub Button_Click(sender As Object, e As RoutedEventArgs)
        ic1.Items.Refresh()
    End Sub

    Private Sub RefreshCanvas(sender As Object, e As DataTransferEventArgs)
        sender.Items.Refresh()
    End Sub
End Class

感谢您为我指明正确方向的任何帮助,希望这也能帮助其他人。


***** 更新,问题已解决 *****


E-Bat好心指出LineData结构本身的属性需要实现INotifyPropertyChanged。我已经实施了此更改并在下面添加了更新和工作的 'MainWindowViewModel.xaml' 代码:

Imports System.ComponentModel
Imports System.Collections.ObjectModel

Public Class MainWindowViewModel
    Inherits ViewModelBase

    ' Sample line data variable
    Private _LineData As ObservableCollection(Of LineData) = GetLineData()
    Public Property LineData As ObservableCollection(Of LineData)
        Get
            Return _LineData
        End Get
        Set(value As ObservableCollection(Of LineData))
            _LineData = value
            OnPropertyChanged("LineData")
        End Set
    End Property

    ' ICommands
    Private _Command1 As ICommand
    Public ReadOnly Property Command1 As ICommand
        Get
            If _Command1 Is Nothing Then
                _Command1 = New MVVM.RelayCommand(AddressOf ExecuteCommand1)
            End If
            Return _Command1
        End Get
    End Property

    Private _Command2 As ICommand
    Public ReadOnly Property Command2 As ICommand
        Get
            If _Command2 Is Nothing Then
                _Command2 = New MVVM.RelayCommand(AddressOf ExecuteCommand2)
            End If
            Return _Command2
        End Get
    End Property

    ' ICommand Methods
    Private Sub ExecuteCommand1()
        ' Re-arrange LineData(0) to make a plus sign on the canvas
        ' This works - Assigning a new value to an item of the collection updates the canvas
        LineData(0) = New LineData With {.X1 = "175", .Y1 = "50", .X2 = "175", .Y2 = "150"}
    End Sub

    Private Sub ExecuteCommand2()
        ' Put LineData(0) back into its original position
        ' Now it works, it's voodoo!
        LineData(0).X1 = "50"
        LineData(0).Y1 = "50"
        LineData(0).X2 = "300"
        LineData(0).Y2 = "50"
    End Sub

    ' Misc methods
    Private Function GetLineData() As ObservableCollection(Of LineData)
        Dim tmpList As New ObservableCollection(Of LineData)

        ' Create two horizontal parallel lines
        tmpList.Add(New LineData With {.X1 = "50", .Y1 = "50", .X2 = "300", .Y2 = "50"})
        tmpList.Add(New LineData With {.X1 = "50", .Y1 = "100", .X2 = "300", .Y2 = "100"})

        OnPropertyChanged("LineData")

        Return tmpList
    End Function
End Class

Public Class LineData
    Implements INotifyPropertyChanged

    Private _X1 As String
    Public Property X1 As String
        Get
            Return _X1
        End Get
        Set(value As String)
            _X1 = value
            OnPropertyChanged("X1")
        End Set
    End Property

    Private _Y1 As String
    Public Property Y1 As String
        Get
            Return _Y1
        End Get
        Set(value As String)
            _Y1 = value
            OnPropertyChanged("Y1")
        End Set
    End Property

    Private _X2 As String
    Public Property X2 As String
        Get
            Return _X2
        End Get
        Set(value As String)
            _X2 = value
            OnPropertyChanged("X2")
        End Set
    End Property

    Private _Y2 As String
    Public Property Y2 As String
        Get
            Return _Y2
        End Get
        Set(value As String)
            _Y2 = value
            OnPropertyChanged("Y2")
        End Set
    End Property

    Public Event PropertyChanged As PropertyChangedEventHandler Implements INotifyPropertyChanged.PropertyChanged

    Protected Sub OnPropertyChanged(ByVal name As String)
        RaiseEvent PropertyChanged(Me, New PropertyChangedEventArgs(name))
    End Sub
End Class

当您替换 ObservableCollection 中的项目时,旧引用将首先被删除,然后添加新引用,因此 ObservableCollection 将触发其事件,这就是第一个命令如此神奇的原因。

现在,对于刷新 UI 的第二个命令,您必须使项目本身、LineStructure 成为 INotifyPropertyChanged 的​​实现者,以便对其属性的任何更改都将通过绑定进行刷新。因此,告别此 class.

的自动化属性
Public Class LineStructure
    Implements INotifyPropertyChanged

    Private _x1 As String
    Public Property X1 As String
        Get
            Return _x1
        End Get
        Set(value As String)
            If _x1 = value Then Return
            _x1 = value
            OnPropertyChanged("X1")
        End Set
    End Property
End Class