WPF中Canvas绑定ObservableCollection无法绘制自定义对象问题排查

在WPF应用中，尝试将ListBox的ItemsPanel设为Canvas，并绑定到自定义Tree对象的ObservableCollection<Tree>集合，但调用命令添加Tree对象后，Canvas始终无法显示这些元素。

原代码 #

XAML代码 #

<ListBox ItemsSource="{Binding Path=Trees}">
    <ListBox.Resources>
        <DataTemplate DataType="{x:Type model:Tree}">
            <TextBlock Text="{Binding Path=Species}"/>
        </DataTemplate>
    </ListBox.Resources>
            
    <ListBox.ItemsPanel>
        <ItemsPanelTemplate>
            <Canvas IsItemsHost="True"/>
        </ItemsPanelTemplate>
    </ListBox.ItemsPanel>

    <ListBox.ItemContainerStyle>
        <Style TargetType="ContentPresenter">
            <Setter Property="Canvas.Left" Value="{Binding Path=PosX}" />
            <Setter Property="Canvas.Top" Value="{Binding Path=PosY}" />
        </Style>
    </ListBox.ItemContainerStyle>

</ListBox>

ViewModel.cs代码 #

public class ViewModel
{
    public ObservableCollection<Tree> Trees { get; set; }

    public ViewModel() { }

    public void OnCreateTreeCommand()
    {
        Trees = new ObservableCollection<Tree>();
        Trees.Add(new Tree("Birch", 50, 50));
    }
}

Tree.cs代码 #

public class Tree
{
    public string Species { get; set; }
    public int PosX { get; set; }
    public int PosY { get; set; }

    public Tree (string species, int posX, int posY)
    {
        Species = species;
        PosX = posX;
        PosY = posY;
    }
}

问题分析 #

问题根源在于ViewModel中的Trees属性未实现INotifyPropertyChanged接口：
虽然ObservableCollection本身会在集合内元素增删时通知UI，但此处是在OnCreateTreeCommand方法中重新实例化ObservableCollection并赋值给Trees属性——这种属性引用的变更，UI无法自动感知，因为原属性是普通自动属性，没有触发PropertyChanged事件。

修复方案 #

让ViewModel实现INotifyPropertyChanged接口，对Trees属性进行封装，在setter中触发属性变更通知：

public class ViewModel : INotifyPropertyChanged
{
    private ObservableCollection<Tree> _trees;
    public ObservableCollection<Tree> Trees
    {
        get => _trees;
        set
        {
            if (value == _trees) return;
            _trees = value;
            OnPropertyChanged(nameof(Trees));
        }
    }

    public event PropertyChangedEventHandler PropertyChanged;

    protected virtual void OnPropertyChanged(string propertyName)
    {
        PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(propertyName));
    }

    public ViewModel() { }

    public void OnCreateTreeCommand()
    {
        Trees = new ObservableCollection<Tree>();
        Trees.Add(new Tree("Birch", 50, 50));
    }
}

补充说明 #

如果在ViewModel构造函数中提前实例化Trees（而非在命令中赋值），也能临时解决问题，但实现INotifyPropertyChanged是更规范的做法，能覆盖所有属性变更场景。

内容的提问来源于stack exchange，提问作者Rikube