在 C# .net winforms 中将字典绑定到 ComboBox

Question

这应该是一个重复的问题，但我发布它是因为任何地方的答案都不起作用。

我有一个类型的字典：

private Dictionary<IModule, AssemblyLoadContext> ModuleList = new Dictionary<IModule, AssemblyLoadContext>();

我正在尝试将 IModule 的名称（IModule.Handle，用于实现 IModule 的所有内容）绑定到组合框。

我尝试了很多东西并在谷歌上搜索了每个答案，但没有任何效果。 这显然是你应该做的方式：

comboBox1.DataSource = new BindingSource(ModuleList, null);
comboBox1.DisplayMember = "Value";
comboBox1.ValueMember = "Key";

当我这样做时，我收到一个 RUNTIME 错误: (System.ArgumentException: 'Cannot bind to the new display member. (Parameter 'newDisplayMember')' )

当我尝试交换键和值时，我得到了同样的错误： (System.ArgumentException: 'Cannot bind to the new display member. (Parameter 'newDisplayMember')' )

当我尝试其他键/值组合时，会得到随机结果。 有时它会显示整个类名（没有帮助），有时它会显示 ToString 表示（重载并完美运行，除非启动后不更新），有时它什么也不显示或程序在运行时出错。

然而，当模块加载和卸载时，我尝试过的任何组合实际上都没有将 BOX 内容更新为 UPDATE（模块本身肯定正在加载/卸载并且工作正常）。

这应该是多年前的工作，我只能想象微软在他们的一个更新中破坏了一些东西，因为预期的方法对我不起作用。

这是使用 .NET core 3.1 模块和 .NET 5.0 应用程序（需要模块才能工作，因为 microsoft 5.0 exe 不适用于 microsoft 5.0 dll）。

IModule 的重载 ToString 方法返回 Handle，它是一个字符串，用于命名模块，即“ConsoleModule”，并按预期工作。 除了数据绑定之外，其他一切都在工作。

至少还有其他人可以确认这种数据绑定方法在 .NET 5.0 和/或 3.1 中确实有效吗？ 迅速失去理智。

Answer 1

每当您想要在 ComboBox 中显示一系列类似项目时，您需要告诉 ComboBox 应该使用项目的哪个属性来显示每个项目。 你是对的，这是使用ComboBox.DisplayMember完成的

您的Dictionary<IModule, AssemblyLoadContext>实现了IEnumerable<KeyValuePair<IModule, AssemblyLoadContext> ，因此您可以将其视为 KeyValuePairs 的序列。 每个 KeyValuePair 都有一个 IModule 类型的 Key 和一个 AssemblyLoadContext 类型的值。

IModule 和 AssemblyLoadContext 有几个属性。 您需要决定要显示它们的哪些属性。

我正在尝试绑定 IModules (IModule.Handle) 的名称

我猜每个 IModule 都有一个属性 Handle，你想在 ComboBox 中显示这个 Handle。

comboBox1.DisplayMember = nameof(IModule.Handle);

如果您只需要显示而不需要更新，那么将您的原始序列转换为列表就足够了：

Dictionary<IModule, AssemblyLoadContext> myData = ...
comboBox.DataSource = myData.ToList();

但是，如果要更新显示的数据，则需要一个实现 IBindingList 的对象，例如（惊喜！） BindingList<T> 。 请参阅BindingList 。

您可以制作BindingList<KeyValuePair<IModule, AssemblyLoadContext>> ，但这很难阅读、难以理解、难以单元测试、难以重用和维护。 我的建议是为此创建一个特殊的类。

我不知道 IModule 中有什么，所以你必须找到一个正确的类名。 我会坚持：

class DisplayedModule
{
    public string DisplayText => this.Module.Handle;

    public IModule Module {get; set;}
    public AssemblyLoadContext AssemblyLoadContext{get; set;}
}

在你的表单的构造函数中：

public MyForm()
{
    InitializeComponent();

    this.ComboBox1.DisplayMember = nameof(DisplayedModule.DisplayText);

这样，如果要更改需要显示的文本，只需更改 DisplayText 属性即可。

public BindingList<DisplayedModule> DisplayedItems
{
    get => (BindingList<DisplayedModule>)this.comboBox1.DataSource;
    set => this.comboBox1.DataSource = value;
}

您需要程序来获取初始数据：

private Dictionary<IModule, AssemblyLoadContext> GetOriginalData() {...} // out of scope of this question

private IEnumerable<DisplayedModule> OriginalDataToDisplay =>
    this.GetOriginalData().Select(keyValuePair => new DisplayedModule
    {
        Module = keyValuePair.Key,
        AssemblyLoadcontext =  keyValuePair.Value;
    });

我已将其放在单独的程序中，以使其非常灵活。 易于理解，易于单元测试，易于更改和维护。 例如，如果您的原始数据不在字典中，而是在列表、数组或数据库中，则只需更改一个过程。

最初填充组合框现在是单行的：

private ShowInitialComboBoxData()
{
    this.DisplayedItems = new BindingList<DisplayedModule>
        (this.OriginalDataToDisplay.ToList());
}

private void OnFormLoad(object sender, ...)
{
    this.ShowInitialComboBoxData();
    ... // other inits during load form
}

如果操作员在列表中添加/删除了一个元素，则绑定列表会自动更新。 如果有事情发生，之后你知道字典已经改变了，你可以简单地改变 bindingList 对于不经常改变的小列表，我会制作一个完整的新 BindingList。 如果List经常变化，或者是一个很大的List，可以考虑添加/删除原来的BindingList。

private void AddDisplayedModule(DisplayedModule module)
{
    this.DisplayedItems.Add(module);
}

private void RemoveDisplayedMOdule(DisplayedModule module)
{
    this.DisplayedItems.Remove(module);
}

private void ModuleAddedToDictionary(IModule module, AssemblyLoadContext assembly)
{
    this.AddDisplayedModule(new DisplayedModule
    {
        Module = module,
        AssemblyLoadContext = assembly,
    })
}

如果操作员进行了一些更改，并指示他完成了对组合框的编辑，例如通过按“立即应用”按钮，您可以简单地获取编辑后的数据：

private void ButtonApplyNowClicked(object sender, ...)
{
    // get the edited data from the combobox and convert to a Dictionary:
    Dictionary<IModule, AssemblyLoadContext> editedData = this.DisplayedItems
        .ToDictionary(displayedItem => displayedItem.Module,               // Key
                      displayedItem => displayedItem.AssemblyLoadContext); // Value;
    this.ProcesEditedData(editedData);
}

访问组合框的选定项

DisplayedModule SelectedModule => (DisplayedModule)this.comboBox1.SelectedItem;

结论

通过将您的数据与其显示方式分开，如果您决定更改视图：将 Combobox 更改为 ListBox，甚至是 DataGridView，更改将是最小的。 或者，如果您决定更改数据：不是字典，而是数据库中的序列