多列列表视图

MultiColumnListView 是一个 UI 控件，通常用于显示具有多列的表格或类似网格的数据。它允许您以结构化格式呈现数据，其中每行代表一个项目或条目，每列代表该项目的特定属性或属性。

创建 MultiColumnListView

您可以使用 UXML 和 C# 创建 MultiColumnListView。以下 C# 示例创建具有两列的 MultiColumnListView：

var multiColumnListView = new MultiColumnListView();
multiColumnListView.columns.Add(new Column { title = "Name", width = 20 });
multiColumnListView.columns.Add(new Column { title = "Power", width = 80 });

刷新集合视图

若要刷新集合视图，可以调用RefreshItems/RefreshItem或Rebuild.

通常，调用RefreshItems或RefreshItem方法——这些方法仅刷新集合视图，并且成本较低。如果您调用Rebuild，则集合视图将完全重建，这可能会很昂贵。

但是，您必须调用Rebuild在以下情况下：

• 您可以更改数据源的类型，例如从List<float>设置为List<Vector3>.
• 您对Column.makeCell或Column.destroyCell.

将 MultiColumnListView 绑定到数据

可以将 MultiColumnListView 绑定到数据源，并根据提供的数据自动填充行和列。

以下示例演示如何将 MultiColumnListView 绑定到 SerializedObject。有关运行时绑定的示例，请参阅 将 ListView 绑定到具有运行时绑定的列表。

如果你有一个具有以下结构的 ScriptableObject：

[Serializable]
public class Move
{
    public string name;
    public int power;
}

[Serializable]
public class Monster
{
    public string name;
    public List<Move> moves;
}

public class MonstersTeam : ScriptableObject
{
    public List<Monster> monstersList;
}

您可以使用以下代码将 MultiColumnListView 绑定到 ScriptableObject：

var multiColumnListView = new MultiColumnListView
{
    bindingPath = "monstersList",
    showBoundCollectionSize = false,
    virtualizationMethod = CollectionVirtualizationMethod.DynamicHeight
};
multiColumnListView.columns.Add(new Column { bindingPath = "name", title = "Name", stretchable = true });
multiColumnListView.columns.Add(new Column { bindingPath = "moves", title = "Moves", stretchable = true });

var so = new SerializedObject(monstersTeam);
multiColumnListView.Bind(so);

这将输出以下视图：

若要使嵌套列表成为 MultiColumnListView，请更改makeCell在“移动”列中：

var multiColumnListView = new MultiColumnListView
{
    bindingPath = "monstersList",
    showBoundCollectionSize = false,
    virtualizationMethod = CollectionVirtualizationMethod.DynamicHeight
};
multiColumnListView.columns.Add(new Column { bindingPath = "name", title = "Name", stretchable = true });
multiColumnListView.columns.Add(new Column { bindingPath = "moves", title = "Moves", stretchable = true,
    makeCell = () =>
    {
        var movesMultiColumnListView = new MultiColumnListView
        {
            showBoundCollectionSize = false,
            virtualizationMethod = CollectionVirtualizationMethod.DynamicHeight,
        };
        movesMultiColumnListView.columns.Add(new Column { bindingPath = "name", title = "Name", stretchable = true });
        movesMultiColumnListView.columns.Add(new Column { bindingPath = "power", title = "Power", stretchable = true });
        return movesMultiColumnListView;
    }}
); 

var so = new SerializedObject(monstersTeam);
multiColumnListView.Bind(so);

这将输出以下视图：

对 MultiColumnListView 进行排序

可以使用默认算法为 MultiColumnListView 启用排序，或者如果默认排序作速度不够快，无法满足需求，则可以实现自定义算法。

启用排序后，要按单列排序，请单击列标题。要对多列进行排序，请按住 Ctrl 键（macOS：Cmd）并单击。要禁用排序，请按住 Shift 键并单击。

默认排序

要使用默认算法启用排序，请将sortingMode属性设置为ColumnSortingMode.Default，并实现Column.comparison按源中的索引比较两个项目。

有关示例，请参阅 MultiColumnListView 默认排序示例。

自定义排序

要实现自定义排序，请将sortingMode属性设置为ColumnSortingMode.Custom，并实现columnSortingChanged回调。在回调中，使用sortColumns相应地重新排序您的列表并触发RefreshItems()一旦项目的来源更新。

这sortColumns属性是排序列的当前状态：它按排序顺序列出列。如果按第 1 列、第 2 列、第 3 列排序，则sortedColumnslist 是 [1， 2， 3]。如果按第 3 列排序，然后按第 2 列排序，然后按第 1 列排序，则sortedColumnslist 是 [3， 2， 1]。

实现 MultiColumnListView 的拖放作

拖放是 UI 设计中的常见功能。若要实现拖放作，请重写以下方法：

• 要启用拖动项，请覆盖canStartDrag.
• 要设置要拖动的项目，请覆盖setupDragAndDrop.
• 若要获取项状态更改，请覆盖dragAndDropUpdate.您可以根据拖动位置或其他条件执行某些作。
• 若要控制拖放行为，请覆盖handleDrop.

在拖放作中，您可以通过拖动来启用项目的重新排序。要启用，请将reorderable属性设置为true在UI Builder、UXML和C#中。

有关示例，请参阅在窗口之间创建拖放列表和树视图。

MultiColumnListView 常见问题解答

下面是有关 MultiColumnListView 控件的一些常见问题。

是否可以获取视图中可见的行列表？

没有专用的 API。您可以使用 UQuery 检索感兴趣的元素。

视图控制器的任何被覆盖函数是否必须调用base.Method?

仅当要扩展其默认行为时，才调用此方法。

我已向我的行添加了一个 Toggle。为什么当用户选择选择时，选择不跳转到该行？

默认情况下，仅当行的内容未使用鼠标向下事件时，才会选择该行。在这种情况下，您的 Toggle 会停止事件传播。要解决此问题，请注册一个PointerDownEvent回调为TrickleDown在切换调用SetSelection.

当用户更改视图中的选择时，如何接收回调？

建议使用selectedIndicesChanged回调以在需要时按索引检索数据。虽然您也可以使用selectionChanged，请注意，它返回一个对象列表，这在与值类型一起使用时可能会导致装箱分配。

我可以获取屏幕上可见的行的索引吗？

没有专用的 API。您可以使用column.bindCell和column.unbindCell以跟踪其中一列上的索引。

我可以有一个水平的 MultiColumnListView 吗？

MultiColumnListView 控件不支持水平布局和虚拟化。建议将 ScrollView 与flex-direction: row水平布局元素。但是，将其应用于 MultiColumnListView 会中断虚拟化。

例子

• 创建列表视图和树视图：使用 ListView、TreeView、MultiColumnListView 和 MultiColumnTreeView 创建列表视图和树视图。
• 在窗口之间创建拖放列表和树视图：使用 ListView、TreeView 和 MultiColumnListView 在窗口之间创建拖放 UI。

C# 基类和命名空间

C# 类：MultiColumnListView
命名空间：UnityEngine.UIElements
基类：BaseListView

成员 UXML 属性

此元素具有以下成员属性：

继承的UXML属性

此元素从其基类继承以下属性：

此元素还继承了以下属性VisualElement:

USS 级

下表列出了所有 C# 公共属性名称及其相关的 USS 选择器。

您还可以使用 Inspector 或 UI Toolkit Debugger 中的 Matching Selectors 部分来查看哪些 USS 选择器会影响VisualElement在其层次结构的各个层面。

其他资源

• 列表视图
• 树视图
• ScrollView一种 UI 控件，用于在可视区域中显示大量控件，您可以使用滚动条查看这些控件。更多信息
  请参阅术语表
• 多列树视图
• 使用运行时绑定将 ListView 绑定到列表