Winforms 中的 IHierarchyData 和 IHierarchicalEnumerable

Question

目前，我知道如何在树视图控件中延迟实现节点的加载过程，并阅读了 stackoverflow 中的相关问题，但我也在阅读有关 asp.net 中的 IHierarchyData 和 IHierarchicalEnumerable 接口（我没有知道编码 asp.net），允许将集合绑定到树视图，以便自动显示项目。

它想知道我是否可以在 winforms 和 C# 中做同样的事情。我认为前面提到的接口在winforms中不可用。

谢谢。

Answer 1

Windows 窗体 TreeView 不知道如何绑定到 IHierarchyData 实例，考虑到 IHierarchyData 和相关接口的预期目的，这并不奇怪供 Web 控件（尤其是站点地图）使用。

然而，构建您自己的数据绑定类实际上并不太难。这似乎是一个有趣的问题，所以我只是为了好玩而把一个问题放在一起。我将引导您了解内部运作方式。

首先，创建一个基本的 Component 类。 Visual Studio 将从这样的代码开始：

public partial class TreeViewHierarchyBinding : Component
{
    public TreeViewHierarchyBinding()
    {
        InitializeComponent();
    }

    public TreeViewHierarchyBinding(IContainer container)
    {
        container.Add(this);
        InitializeComponent();
    }
}

该组件需要具有的一个明显的“状态”是从每个 TreeNode 到其 IHierarchyData 的映射。现在我们可以通过将其放入 TreeNode 的 Tag 属性来解决这个问题，但我们的目标是使该组件尽可能非侵入性并跟踪它自己的状态。因此，我们将使用字典。将此字段添加到类中：

private Dictionary<TreeNode, IHierarchyData> nodeDictionary = new 
    Dictionary<TreeNode, IHierarchyData>();

现在，该组件至少需要知道如何从其相应绑定的 填充 TreeView 类的特定父 TreeNode IHierarchyData，所以接下来让我们编写该代码：

private void PopulateChildNodes(TreeNodeCollection parentCollection,
    IHierarchicalEnumerable children)
{
    parentCollection.Clear();
    foreach (object child in children)
    {
        IHierarchyData childData = children.GetHierarchyData(child);
        TreeNode childNode = new TreeNode(childData.ToString());
        if (childData.HasChildren)
        {
            childNode.Nodes.Add("Dummy");   // Make expandable
        }
        nodeDictionary.Add(childNode, childData);
        parentCollection.Add(childNode);
    }
}

private void UpdateRootNodes(TreeView tv, IHierarchyData hierarchyData)
{
    if (tv == null)
    {
        return;
    }
    tv.Nodes.Clear();
    if (hierarchyData != null)
    {
        IHierarchicalEnumerable roots = hierarchyData.GetChildren();
        PopulateChildNodes(tv.Nodes, roots);
    }
}

这部分应该非常简单。第一个方法只是使用从 IHierarchyData 获取的层次结构填充 TreeNodeCollection（即 TreeNode 的 Nodes 属性） > 实例，使用 IHierarchyEnumerable 接口。此方法唯一真正有趣的事情是：

1. 当 IHierarchyData 实例有子节点时添加虚拟节点；这使得“+”在树视图中可见，否则我们将无法进一步展开；

2. 使用与之匹配的 IHierarchyData 实例将新添加的节点添加到字典中。

第二种方法更简单，它执行初始“绑定工作”，用我们的顶级 IHierarchyData 实例替换树的root 中的任何内容。

我们的组件需要做的下一件事是挂钩 TreeView 中的加载事件以执行延迟加载。下面是执行此操作的代码：

private void RegisterEvents(TreeView tv)
{
    tv.BeforeExpand += TreeViewBeforeExpand;
}

private void UnregisterEvents(TreeView tv)
{
    tv.BeforeExpand -= TreeViewBeforeExpand;
}

private void TreeViewBeforeExpand(object sender, TreeViewCancelEventArgs e)
{
    if (e.Node.Checked)
    {
        return;
    }
    IHierarchyData hierarchyData;
    if (nodeDictionary.TryGetValue(e.Node, out hierarchyData))
    {
        PopulateChildNodes(e.Node.Nodes, hierarchyData.GetChildren());
        e.Node.Checked = true;
    }
}

前两个方法应该是不言自明的，第三个方法是实际的延迟加载代码。我们在这里做了一点欺骗，使用 TreeNode.Checked 属性来描述子节点是否已经加载，这样我们就不会进行任何不必要的重新加载。当我实现延迟加载树时，我总是这样做，因为根据我的经验，我几乎从不使用 TreeNode.Checked 属性。但是，如果您确实需要将此属性用于其他用途，则可以使用不同的属性（例如 Tag），创建另一个字典来保存扩展状态，或者修改现有字典来保存复合类（包含 IHierarchyData 以及 Expanded 属性）。我现在保持简单。

如果您之前已经在树中实现了延迟加载，那么其余的内容应该已经对您有意义，所以让我们跳过。实际上，此时唯一要做的就是实现一些设计者/用户属性，这些属性将实际连接树和数据：

private IHierarchyData dataSource;
private TreeView treeView;

[Browsable(false)]
[DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
public IHierarchyData DataSource
{
    get { return dataSource; }
    set
    {
        if (value != dataSource)
        {
            dataSource = value;
            nodeDictionary.Clear();
            UpdateRootNodes(treeView, value);
        }
    }
}

[Category("Behavior")]
[DefaultValue(null)]
[Description("Specifies the TreeView that the hierarchy should be bound to.")]
public TreeView TreeView
{
    get { return treeView; }
    set
    {
        if (value != treeView)
        {
            if (treeView != null)
            {
                UnregisterEvents(treeView);
            }
            treeView = value;
            nodeDictionary.Clear();
            RegisterEvents(value);
            UpdateRootNodes(treeView, dataSource);
        }
    }
}

简单。我们有一个接受根IHierarchyData 的DataSource 属性，以及一个您可以从设计器访问的TreeView 属性。同样，这里的事情很简单，当 DataSource 属性更新时，我们只需重置查找并重新填充根。当 TreeView 属性更新时，我们必须做更多的工作，注册事件，确保从旧树视图中注销事件，并执行数据源更改时所做的所有相同操作。

这真的就是全部了！打开 Windows 窗体设计器，放置一个 TreeView，然后放置一个 TreeViewHierarchyBinding，并将其 TreeView 属性设置为刚刚放置的树视图。最后，在代码中的某个位置（即在 Form_Load 事件中），为其提供一个数据源：（

private void Form1_Load(object sender, EventArgs e)
{
    DirectoryInfo dir = new DirectoryInfo("C:\\");
    treeViewHierarchyBinding1.DataSource = new FileSystemHierarchyData(dir);
}

注意 - 这使用 IHierarchyData 的 MSDN 页面。该示例不是很强大，它不会检查 UnauthorizedAccessException 或任何其他内容，但它足以证明这一点）。

就是这样。运行您的应用程序并观察它的绑定。现在，您可以在任何地方重用 TreeViewHierarchyBinding 组件 - 只需将其放在表单上，​​为其分配一个 TreeView，并为其提供一个 IHierarchyData 实例作为数据源。

如果您想要复制粘贴版本，我已将完整代码放在PasteBin上。

玩得开心！

Answer 2

这些接口可用，但需要您添加对 System.Web.UI 的引用。 （它可能还要求您使用完整的 .NET Framework 可再发行组件而不是 Client Profile，尽管我对此并不确定。）

更大的问题是：WinForms TreeView 控件是否自动理解如何使用这些接口？我相信这个问题的答案是“否”，但您需要测试/验证这一点。

Answer 3

有一篇有趣的文章 这里向您展示了如何构建扩展方法来实现我认为您正在寻找的目标。 System.Windows.Forms.TreeView 中没有本机可用性来绑定到我能找到的集合。

您可以在项目中包含 System.Web.UI 以使 IHierarchyData 和 IHierarchicalEnumerable 接口可用，但如果没有扩展方法，TreeView 将无法附加到它们。

该网站的示例源代码将允许您将任何 IDictionary 集合绑定到 TreeView。