DataGridTemplateColumn中TagSelect自定义控件绑定失效问题

我开发了一款多选分类标签自定义控件TagSelect，它的依赖属性SelectedTags用于接收初始选中的Tag列表（Tag类包含TagID、Name、Description属性）。控件单独在Grid中使用时绑定正常，但放入DataGridTemplateColumn的CellEditingTemplate中时，SelectedTags始终为null，在OnApplyTemplate方法断点处可确认此问题。

DataGrid的ItemsSource是ObservableCollection<DataEntry>，DataEntry类包含Tags（List）属性，同一列CellTemplate中的TextBlock绑定TagString能正常获取DataContext，但CellEditingTemplate内的TagSelect无法绑定到Tags属性。

核心代码 #

1. Tag类定义 #

public class Tag : ObservableObject
{
  public int TagID
  {
    get => tagID;
    set => SetProperty(ref tagID, value);
  }
  public string Name
  {
    get => tagName; 
    set => SetProperty(ref tagName, value);
  }
  public string Description
  {
    get => description; 
    set => SetProperty(ref description, value);
  }
}

2. DataEntry类定义 #

public class DataEntry : ObservableObject
{
private int id;
public int ID
{
  get => id;
  set => SetProperty(ref id, value);
}
private string? name;
public string? Name
{
  get => name;
  set => SetProperty(ref name, value);
}
private List<Tag> tags;
public List<Tag> Tags
{
  get => tags;
  set => SetProperty(ref tags, value);
}
private string tagString;
public string TagString
{
  get => tagString;
  set => SetProperty(ref tagString, value); 
}
public DataEntry()
{
  tags = new List<Tag>();
}
}

3. SelectedTags依赖属性定义 #

public List<Tag> SelectedTags
{
  get { return (List<Tag>)GetValue(SelectedTagsProperty); }
  set { SetValue(SelectedTagsProperty, value); }
}
public static readonly DependencyProperty SelectedTagsProperty =
            DependencyProperty.Register("SelectedTags", typeof(List<Tag>),
                        typeof(TagSelect),
            new FrameworkPropertyMetadata(null, 
                          FrameworkPropertyMetadataOptions.BindsTwoWayByDefault));

4. DataGrid模板列定义 #

<DataGridTemplateColumn Width="175" Header="Tags">
  <DataGridTemplateColumn.CellTemplate>
    <DataTemplate>
      <TextBlock Text="{Binding TagString}" Width="175"/>
    </DataTemplate>
  </DataGridTemplateColumn.CellTemplate>
  <DataGridTemplateColumn.CellEditingTemplate>
    <DataTemplate>
      <cc:TagSelect Width="175" SelectedTags="{Binding Tags}" />
    </DataTemplate>
  </DataGridTemplateColumn.CellEditingTemplate>
</DataGridTemplateColumn>

问题解答 #

1. CellEditingTemplate中绑定失效的原因 #

• 集合类型缺乏变更通知：DataEntry的Tags是List<Tag>，未实现INotifyCollectionChanged接口，绑定系统无法追踪集合的初始化与变更，导致编辑模式下无法正确同步初始值。
• 依赖属性与集合类型适配问题：自定义控件的SelectedTags依赖属性使用List<Tag>作为类型，WPF绑定更适配具备变更通知的ObservableCollection<T>；同时依赖属性默认值为null，模板应用阶段DataContext传递可能存在延迟，导致初始绑定未触发。

2. DataGridTemplateColumn是否支持此类绑定 #

DataGridTemplateColumn完全支持这类绑定，问题不在列本身——同一列CellTemplate能正常绑定说明DataContext传递正常，问题出在绑定的集合类型、依赖属性定义的细节适配上。

3. 替代方案与修复方法 #

方案一：替换集合类型为ObservableCollection

将DataEntry和自定义控件的集合类型改为ObservableCollection<Tag>，利用其变更通知能力确保绑定同步：

// 修改DataEntry的Tags属性
private ObservableCollection<Tag> tags;
public ObservableCollection<Tag> Tags
{
  get => tags;
  set => SetProperty(ref tags, value);
}
public DataEntry()
{
  tags = new ObservableCollection<Tag>();
}

// 修改TagSelect的依赖属性
public ObservableCollection<Tag> SelectedTags
{
  get { return (ObservableCollection<Tag>)GetValue(SelectedTagsProperty); }
  set { SetValue(SelectedTagsProperty, value); }
}
public static readonly DependencyProperty SelectedTagsProperty =
            DependencyProperty.Register("SelectedTags", typeof(ObservableCollection<Tag>),
                        typeof(TagSelect),
            new FrameworkPropertyMetadata(null, 
                          FrameworkPropertyMetadataOptions.BindsTwoWayByDefault));

方案二：显式指定绑定源

通过RelativeSource强制控件从父级DataGridCell获取DataContext，避免模板传递延迟：

<cc:TagSelect Width="175" SelectedTags="{Binding DataContext.Tags, RelativeSource={RelativeSource AncestorType=DataGridCell}}" />

方案三：手动初始化控件值

在TagSelect的OnApplyTemplate方法中，手动读取DataContext并初始化SelectedTags：

public override void OnApplyTemplate()
{
  base.OnApplyTemplate();
  if (DataContext is DataEntry entry && SelectedTags == null)
  {
    SelectedTags = new List<Tag>(entry.Tags);
  }
}

注意需额外处理双向绑定的回写逻辑，确保控件修改能同步到DataEntry的Tags属性。

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