Как привязать WPF DataGrid к переменному количеству столбцов?


124

Мое приложение WPF генерирует наборы данных, которые каждый раз могут иметь разное количество столбцов. В выходные данные включено описание каждого столбца, который будет использоваться для применения форматирования. Упрощенная версия вывода может выглядеть примерно так:

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

Этот класс установлен как DataContext в WPF DataGrid, но на самом деле я создаю столбцы программно:

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?

Ответы:


127

Вот обходной путь для привязки столбцов в DataGrid. Поскольку свойство Columns имеет значение ReadOnly, как все заметили, я создал прикрепленное свойство под названием BindableColumns, которое обновляет столбцы в DataGrid каждый раз, когда коллекция изменяется через событие CollectionChanged.

Если у нас есть эта коллекция DataGridColumn's

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, чтобы предотвратить утечку памяти. Просто для вашего убеждения.
Майк Эшва

3
Вы регистрируете обработчик событий в CollectionChangedсобытии коллекции столбцов, но никогда не отменяете его регистрацию. Таким образом, DataGridобъект будет оставаться в живых до тех пор, пока существует модель представления, даже если шаблон элемента управления, который изначально содержал DataGridобъект, был заменен. Есть ли какой-либо гарантированный способ снова отменить регистрацию этого обработчика событий, когда он DataGridбольше не требуется?
OR Mapper

1
@OR Mapper: Теоретически есть, но не работает: WeakEventManager <ObservableCollection <DataGridColumn>, NotifyCollectionChangedEventArgs> .AddHandler (columns, "CollectionChanged", (s, ne) => {switch ....});
too

6
Это не лучшее решение. Основная причина в том, что вы используете классы пользовательского интерфейса в ViewModel. Также это не сработает, когда вы попытаетесь создать какое-либо переключение страниц. При переключении обратно на страницу с такой сеткой данных вы получите ожидание в строке dataGrid.Columns.Add(column)DataGridColumn с заголовком «X», уже существующим в коллекции Columns DataGrid. DataGrids не может совместно использовать столбцы и не может содержать повторяющиеся экземпляры столбцов.
Руслан Ф.

19

Я продолжил свои исследования и не нашел разумного способа сделать это. Свойство Columns в DataGrid не является чем-то, к чему я могу привязаться, на самом деле оно только для чтения.

Брайан предположил, что что-то можно сделать с помощью 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/…
Михаил

4
Нет, не будет. Во всяком случае, это не указанная ссылка, потому что результат этого решения совершенно другой!
321X,

2
Похоже, что решение Mealek более универсально и полезно в ситуациях, когда прямое использование кода C # проблематично, например, в ControlTemplates.
EFraim 07

@Mikhail ссылка не работает
LuckyLikey


9

Я нашел статью в блоге Деборы Курата с хорошим трюком, как показывать переменное количество столбцов в DataGrid:

Заполнение DataGrid динамическими столбцами в приложении Silverlight с помощью MVVM

По сути, она создает DataGridTemplateColumnи помещает ItemsControlвнутрь, отображающее несколько столбцов.


1
Это далеко не такой результат, как у запрограммированной версии !!
321X,

1
@ 321X: Не могли бы вы подробнее рассказать о наблюдаемых различиях (а также указать, что вы имеете в виду под запрограммированной версией , поскольку все решения этой проблемы запрограммированы), пожалуйста?
OR Mapper



Это просто потрясающе !!
Равид Голденберг,

6

Мне удалось сделать возможным динамическое добавление столбца, используя только такую ​​строку кода:

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

Что касается вопроса, это не решение на основе XAML (поскольку, как уже упоминалось, нет разумного способа сделать это), а также решение, которое будет работать напрямую с DataGrid.Columns. Фактически он работает с ItemsSource, привязанным к DataGrid, который реализует 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, будет заполнена соответствующими столбцами. Эти столбцы можно изменять (добавлять новые или удалять существующие) во время выполнения динамически, и сетка автоматически обновляет коллекцию столбцов.

Упомянутый выше 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.
Я борюсь с этим, но получил работу, вызвав after InitalizeComponentв моем конструкторе окна (childGrid - это x: name в window.xaml):

childGrid.deGrid.LoadGrid();

Связанная запись в блоге


1

Возможно, вы сможете сделать это с помощью AutoGenerateColumns и DataTemplate. Я не уверен, что это будет работать без большого количества работы, вам придется поиграть с этим. Честно говоря, если у вас уже есть рабочее решение, я бы пока не стал вносить изменения, если для этого нет веской причины. Элемент управления DataGrid становится очень хорошим, но он все еще нуждается в некоторой доработке (а мне еще предстоит много учиться), чтобы легко выполнять такие динамические задачи.


Моя причина в том, что из ASP.Net я новичок в том, что можно сделать с приличной привязкой данных, и я не уверен, где это ограничения. Я поиграю с AutoGenerateColumns, спасибо.
Generic Error

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; }
}
Используя наш сайт, вы подтверждаете, что прочитали и поняли нашу Политику в отношении файлов cookie и Политику конфиденциальности.
Licensed under cc by-sa 3.0 with attribution required.