如何将WPF DataGrid绑定到可变数量的列?


124

我的WPF应用程序生成的数据集每次可能具有不同的列数。输出中包括对将用于应用格式设置的每一列的描述。输出的简化版本可能类似于:

class Data
{
    IList<ColumnDescription> ColumnDescriptions { get; set; }
    string[][] Rows { get; set; }
}

此类设置为WPF DataGrid上的DataContext,但实际上是通过编程方式创建的:

for (int i = 0; i < data.ColumnDescriptions.Count; i++)
{
    dataGrid.Columns.Add(new DataGridTextColumn
    {
        Header = data.ColumnDescriptions[i].Name,
        Binding = new Binding(string.Format("[{0}]", i))
    });
}

有什么方法可以用XAML文件中的数据绑定替换此代码吗?

Answers:


127

这是DataGrid中的绑定列的解决方法。由于Columns属性是ReadOnly,就像每个人都注意到的那样,我创建了一个名为BindableColumns的附加属性,该属性每次通过CollectionChanged事件更改集合时都会更新DataGrid中的Columns。

如果我们有这个DataGridColumn的集合

public ObservableCollection<DataGridColumn> ColumnCollection
{
    get;
    private set;
}

然后我们可以像这样将BindableColumns绑定到ColumnCollection

<DataGrid Name="dataGrid"
          local:DataGridColumnsBehavior.BindableColumns="{Binding ColumnCollection}"
          AutoGenerateColumns="False"
          ...>

附加属性BindableColumns

public class DataGridColumnsBehavior
{
    public static readonly DependencyProperty BindableColumnsProperty =
        DependencyProperty.RegisterAttached("BindableColumns",
                                            typeof(ObservableCollection<DataGridColumn>),
                                            typeof(DataGridColumnsBehavior),
                                            new UIPropertyMetadata(null, BindableColumnsPropertyChanged));
    private static void BindableColumnsPropertyChanged(DependencyObject source, DependencyPropertyChangedEventArgs e)
    {
        DataGrid dataGrid = source as DataGrid;
        ObservableCollection<DataGridColumn> columns = e.NewValue as ObservableCollection<DataGridColumn>;
        dataGrid.Columns.Clear();
        if (columns == null)
        {
            return;
        }
        foreach (DataGridColumn column in columns)
        {
            dataGrid.Columns.Add(column);
        }
        columns.CollectionChanged += (sender, e2) =>
        {
            NotifyCollectionChangedEventArgs ne = e2 as NotifyCollectionChangedEventArgs;
            if (ne.Action == NotifyCollectionChangedAction.Reset)
            {
                dataGrid.Columns.Clear();
                foreach (DataGridColumn column in ne.NewItems)
                {
                    dataGrid.Columns.Add(column);
                }
            }
            else if (ne.Action == NotifyCollectionChangedAction.Add)
            {
                foreach (DataGridColumn column in ne.NewItems)
                {
                    dataGrid.Columns.Add(column);
                }
            }
            else if (ne.Action == NotifyCollectionChangedAction.Move)
            {
                dataGrid.Columns.Move(ne.OldStartingIndex, ne.NewStartingIndex);
            }
            else if (ne.Action == NotifyCollectionChangedAction.Remove)
            {
                foreach (DataGridColumn column in ne.OldItems)
                {
                    dataGrid.Columns.Remove(column);
                }
            }
            else if (ne.Action == NotifyCollectionChangedAction.Replace)
            {
                dataGrid.Columns[ne.NewStartingIndex] = ne.NewItems[0] as DataGridColumn;
            }
        };
    }
    public static void SetBindableColumns(DependencyObject element, ObservableCollection<DataGridColumn> value)
    {
        element.SetValue(BindableColumnsProperty, value);
    }
    public static ObservableCollection<DataGridColumn> GetBindableColumns(DependencyObject element)
    {
        return (ObservableCollection<DataGridColumn>)element.GetValue(BindableColumnsProperty);
    }
}

1
MVVM模式的不错解决方案
WPFKK

2
完美的解决方案!可能您需要在BindableColumnsPropertyChanged中做一些其他事情:1.在访问dataGrid之前检查其是否为null,并抛出一个异常,说明仅绑定到DataGrid。2.检查e.OldValue是否为null,并取消订阅CollectionChanged事件以防止内存泄漏。只为您说服。
Mike Eshva

3
CollectionChanged向column集合的事件注册了一个事件处理程序,但是从不取消注册它。这样一来,DataGrid只要视图模型存在,只要将原来包含的控件模板DataGrid进行了替换,它将一直保持活动状态。当DataGrid不再需要时,是否有保证的方法可以再次注销该事件处理程序?
OR Mapper

1
@OR映射器:从理论上讲,但是它不起作用:WeakEventManager <ObservableCollection <DataGridColumn>,NotifyCollectionChangedEventArgs> .AddHandler(columns,“ CollectionChanged”,(s,ne)=> {switch ....});
也是

6
这不是bes解决方案。主要原因是您在ViewModel中使用UI类。当您尝试创建某些页面切换时,它也将不起作用。当切换回带有此类datagrid的页面时,您将在dataGrid.Columns.Add(column)DataGridColumn 行中得到一个期望,其标题为“ X”,已存在于DataGrid的Columns集合中。DataGrid不能共享列,并且不能包含重复的列实例。
Ruslan F.

19

我已经继续研究,还没有找到任何合理的方法来做到这一点。我不能绑定DataGrid上的Columns属性,实际上它是只读的。

Bryan建议使用AutoGenerateColumns进行某些操作,所以我来看看。它使用简单的.Net反射来查看ItemsSource中对象的属性,并为每个对象生成一列。也许我可以即时为每个列生成一个带有属性的类型,但这已经偏离了轨道。

由于此问题很容易在代码中解决,所以只要数据上下文用新列更新,我都会坚持使用一种简单的扩展方法:

public static void GenerateColumns(this DataGrid dataGrid, IEnumerable<ColumnSchema> columns)
{
    dataGrid.Columns.Clear();

    int index = 0;
    foreach (var column in columns)
    {
        dataGrid.Columns.Add(new DataGridTextColumn
        {
            Header = column.Name,
            Binding = new Binding(string.Format("[{0}]", index++))
        });
    }
}

// E.g. myGrid.GenerateColumns(schema);

1
票数最高且被接受的解决方案不是最佳解决方案!两年后的答案是:msmvps.com/blogs/deborahk/archive/2011/01/23/…–
Mikhail

4
不,不会。无论如何,都没有提供链接,因为该解决方案的结果完全不同!
321X 2011年

2
似乎Mealek的解决方案更加通用,并且在直接使用C#代码有问题的情况下(例如在ControlTemplates中)很有用。
EFraim 2011年

@Mikhail链接已损坏
LuckyLikey


9

我找到了Deborah Kurata的博客文章,其中有一个很好的技巧,如何在DataGrid中显示可变的列数:

使用MVVM在Silverlight应用程序中用动态列填充DataGrid

基本上,她创建一个DataGridTemplateColumn并放入ItemsControl其中以显示多个列。


1
到目前为止,结果与编程版本不一样!!
321X 2011年

1
@ 321X:能否请您详细说明观察到的差异(并指定您所指的是编程版本,因为对此的所有解决方案都是经过编程的)?
OR Mapper 2013年

它说“找不到页面”
Jeson Martajaya


这简直是​​惊人的!
Ravid Goldenberg

6

我设法使仅使用一行代码就可以动态添加列,如下所示:

MyItemsCollection.AddPropertyDescriptor(
    new DynamicPropertyDescriptor<User, int>("Age", x => x.Age));

关于这个问题,这不是基于XAML的解决方案(因为如上所述,没有合理的方法来实现),也不是可以直接与DataGrid.Columns一起使用的解决方案。它实际上与DataGrid绑定的ItemsSource一起运行,ItemSource实现ITypedList并因此提供了用于PropertyDescriptor检索的自定义方法。在代码的一处,您可以为网格定义“数据行”和“数据列”。

如果您有:

IList<string> ColumnNames { get; set; }
//dict.key is column name, dict.value is value
Dictionary<string, string> Rows { get; set; }

您可以使用例如:

var descriptors= new List<PropertyDescriptor>();
//retrieve column name from preprepared list or retrieve from one of the items in dictionary
foreach(var columnName in ColumnNames)
    descriptors.Add(new DynamicPropertyDescriptor<Dictionary, string>(ColumnName, x => x[columnName]))
MyItemsCollection = new DynamicDataGridSource(Rows, descriptors) 

使用绑定到MyItemsCollection的网格将填充相应的列。这些列可以在运行时动态修改(添加或删除的新列),并且Grid会自动刷新其列集合。

上面提到的DynamicPropertyDescriptor只是常规PropertyDescriptor的升级,并提供带有一些其他选项的强类型列定义。否则,DynamicDataGridSource使用基本的PropertyDescriptor可以正常工作。


3

制作了处理退订的已接受答案的版本。

public class DataGridColumnsBehavior
{
    public static readonly DependencyProperty BindableColumnsProperty =
        DependencyProperty.RegisterAttached("BindableColumns",
                                            typeof(ObservableCollection<DataGridColumn>),
                                            typeof(DataGridColumnsBehavior),
                                            new UIPropertyMetadata(null, BindableColumnsPropertyChanged));

    /// <summary>Collection to store collection change handlers - to be able to unsubscribe later.</summary>
    private static readonly Dictionary<DataGrid, NotifyCollectionChangedEventHandler> _handlers;

    static DataGridColumnsBehavior()
    {
        _handlers = new Dictionary<DataGrid, NotifyCollectionChangedEventHandler>();
    }

    private static void BindableColumnsPropertyChanged(DependencyObject source, DependencyPropertyChangedEventArgs e)
    {
        DataGrid dataGrid = source as DataGrid;

        ObservableCollection<DataGridColumn> oldColumns = e.OldValue as ObservableCollection<DataGridColumn>;
        if (oldColumns != null)
        {
            // Remove all columns.
            dataGrid.Columns.Clear();

            // Unsubscribe from old collection.
            NotifyCollectionChangedEventHandler h;
            if (_handlers.TryGetValue(dataGrid, out h))
            {
                oldColumns.CollectionChanged -= h;
                _handlers.Remove(dataGrid);
            }
        }

        ObservableCollection<DataGridColumn> newColumns = e.NewValue as ObservableCollection<DataGridColumn>;
        dataGrid.Columns.Clear();
        if (newColumns != null)
        {
            // Add columns from this source.
            foreach (DataGridColumn column in newColumns)
                dataGrid.Columns.Add(column);

            // Subscribe to future changes.
            NotifyCollectionChangedEventHandler h = (_, ne) => OnCollectionChanged(ne, dataGrid);
            _handlers[dataGrid] = h;
            newColumns.CollectionChanged += h;
        }
    }

    static void OnCollectionChanged(NotifyCollectionChangedEventArgs ne, DataGrid dataGrid)
    {
        switch (ne.Action)
        {
            case NotifyCollectionChangedAction.Reset:
                dataGrid.Columns.Clear();
                foreach (DataGridColumn column in ne.NewItems)
                    dataGrid.Columns.Add(column);
                break;
            case NotifyCollectionChangedAction.Add:
                foreach (DataGridColumn column in ne.NewItems)
                    dataGrid.Columns.Add(column);
                break;
            case NotifyCollectionChangedAction.Move:
                dataGrid.Columns.Move(ne.OldStartingIndex, ne.NewStartingIndex);
                break;
            case NotifyCollectionChangedAction.Remove:
                foreach (DataGridColumn column in ne.OldItems)
                    dataGrid.Columns.Remove(column);
                break;
            case NotifyCollectionChangedAction.Replace:
                dataGrid.Columns[ne.NewStartingIndex] = ne.NewItems[0] as DataGridColumn;
                break;
        }
    }

    public static void SetBindableColumns(DependencyObject element, ObservableCollection<DataGridColumn> value)
    {
        element.SetValue(BindableColumnsProperty, value);
    }

    public static ObservableCollection<DataGridColumn> GetBindableColumns(DependencyObject element)
    {
        return (ObservableCollection<DataGridColumn>)element.GetValue(BindableColumnsProperty);
    }
}

2

您可以使用网格定义创建用户控件,并在xaml中使用不同的列定义定义“子”控件。父级需要列的依赖项属性和加载列的方法:

上级:


public ObservableCollection<DataGridColumn> gridColumns
{
  get
  {
    return (ObservableCollection<DataGridColumn>)GetValue(ColumnsProperty);
  }
  set
  {
    SetValue(ColumnsProperty, value);
  }
}
public static readonly DependencyProperty ColumnsProperty =
  DependencyProperty.Register("gridColumns",
  typeof(ObservableCollection<DataGridColumn>),
  typeof(parentControl),
  new PropertyMetadata(new ObservableCollection<DataGridColumn>()));

public void LoadGrid()
{
  if (gridColumns.Count > 0)
    myGrid.Columns.Clear();

  foreach (DataGridColumn c in gridColumns)
  {
    myGrid.Columns.Add(c);
  }
}

儿童Xaml:


<local:parentControl x:Name="deGrid">           
  <local:parentControl.gridColumns>
    <toolkit:DataGridTextColumn Width="Auto" Header="1" Binding="{Binding Path=.}" />
    <toolkit:DataGridTextColumn Width="Auto" Header="2" Binding="{Binding Path=.}" />
  </local:parentControl.gridColumns>  
</local:parentControl>

最后,棘手的部分是找到在何处调用“ LoadGrid”。
我为此感到挣扎,但通过InitalizeComponent在我的窗口构造函数中调用之后使事情起作用(childGrid是window.xaml中的x:name):

childGrid.deGrid.LoadGrid();

相关博客条目


1

您可能可以使用AutoGenerateColumns和一个DataTemplate做到这一点。我不太肯定如果不进行大量工作就可以正常工作,那么您将不得不尝试一下。老实说,如果您已经有了一个可行的解决方案,除非有很大的理由,否则我不会立即进行更改。DataGrid控件变得非常好,但是它仍然需要一些工作(还有很多要做的工作要做),以便能够轻松地执行这样的动态任务。


我的理由是,来自ASP.Net的我对使用像样的数据绑定可以做的事情还是陌生的,我不确定它的限制在哪里。谢谢,我将和AutoGenerateColumns一起玩。
通用错误

0

我以编程方式提供了一个示例:

public partial class UserControlWithComboBoxColumnDataGrid : UserControl
{
    private Dictionary<int, string> _Dictionary;
    private ObservableCollection<MyItem> _MyItems;
    public UserControlWithComboBoxColumnDataGrid() {
      _Dictionary = new Dictionary<int, string>();
      _Dictionary.Add(1,"A");
      _Dictionary.Add(2,"B");
      _MyItems = new ObservableCollection<MyItem>();
      dataGridMyItems.AutoGeneratingColumn += DataGridMyItems_AutoGeneratingColumn;
      dataGridMyItems.ItemsSource = _MyItems;

    }
private void DataGridMyItems_AutoGeneratingColumn(object sender, DataGridAutoGeneratingColumnEventArgs e)
        {
            var desc = e.PropertyDescriptor as PropertyDescriptor;
            var att = desc.Attributes[typeof(ColumnNameAttribute)] as ColumnNameAttribute;
            if (att != null)
            {
                if (att.Name == "My Combobox Item") {
                    var comboBoxColumn =  new DataGridComboBoxColumn {
                        DisplayMemberPath = "Value",
                        SelectedValuePath = "Key",
                        ItemsSource = _ApprovalTypes,
                        SelectedValueBinding =  new Binding( "Bazinga"),   
                    };
                    e.Column = comboBoxColumn;
                }

            }
        }

}
public class MyItem {
    public string Name{get;set;}
    [ColumnName("My Combobox Item")]
    public int Bazinga {get;set;}
}

  public class ColumnNameAttribute : Attribute
    {
        public string Name { get; set; }
        public ColumnNameAttribute(string name) { Name = name; }
}
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.