BaseListView

UnityEngine.UIElements 中的类

继承自:UIElements.BaseVerticalCollectionView

留下反馈

建议更改

描述

列表视图的基本类，一个垂直可滚动区域，链接到并显示项目列表。

静态属性

arraySizeFieldUssClassName	启用显示绑定集合大小时，ListView 的大小字段的 USS 类名。
arraySizeFieldWithFooterUssClassName	启用页脚时，ListView 的大小字段的 USS 类名。
arraySizeFieldWithHeaderUssClassName	启用折叠标题时，ListView 的大小字段的 USS 类名。
emptyLabelUssClassName	ListView 为空时显示的标签的 USS 类名。
foldoutHeaderUssClassName	ListView 的折叠标题的 USS 类名。
footerAddButtonName	页脚中添加按钮元素的名称。
footerRemoveButtonName	页脚中删除按钮元素的名称。
footerUssClassName	ListView 的页脚的 USS 类名。
itemUssClassName	ListView 元素中项目元素的 USS 类名。
listViewWithFooterUssClassName	启用添加/删除页脚时，ListView 的 USS 类名。
listViewWithHeaderUssClassName	启用折叠标题时，ListView 的 USS 类名。
overMaxMultiEditLimitClassName	ListView 尝试编辑过多项目时显示的标签的 USS 类名。
reorderableItemContainerUssClassName	可重新排序的动画 ListView 中项目容器的 USS 类名。
reorderableItemHandleBarUssClassName	可重新排序的动画 ListView 中拖动句柄栏的 USS 类名。
reorderableItemHandleUssClassName	可重新排序的动画 ListView 中拖动句柄的 USS 类名。
reorderableItemUssClassName	可重新排序的动画 ListView 中项目元素的 USS 类名。
reorderableUssClassName	可重新排序的动画 ListView 元素的 USS 类名。
scrollViewWithFooterUssClassName	启用添加/删除页脚时，滚动视图的 USS 类名。
ussClassName	ListView 元素的 USS 类名。

属性

allowAdd	此属性允许用户在单击“添加”按钮时允许或阻止添加项目。它必须返回 true 或 false。
allowRemove	此属性允许用户在单击“删除”按钮时允许或阻止删除项目。它必须返回 true 或 false。
bindingSourceSelectionMode	此属性控制列表中的每个元素是否将其数据源自动设置为集合源中的正确项目。
headerTitle	使用 showFoldoutHeader 时，此属性控制折叠标题的文本。
makeFooter	此回调允许用户为该控件创建自己的页脚。
makeHeader	此回调允许用户为该控件创建自己的标题。
makeNoneElement	此回调允许用户设置一个 Visual Element 来替换 ListView 为空时显示的“列表为空”标签。
onAdd	此回调允许用户实现自己的代码，以便在单击“添加”按钮时执行。
onRemove	此回调允许用户实现自己的代码，以便在单击“删除”按钮时执行。
overridingAddButtonBehavior	此回调允许用户在单击“添加”按钮时实现一个下拉菜单。
reorderMode	此属性控制列表视图的拖放模式。
showAddRemoveFooter	此属性控制是否将页脚添加到列表视图。
showBoundCollectionSize	此属性控制列表视图是否显示集合大小（项目数）。
showFoldoutHeader	此属性控制列表视图是否显示标题，标题以可展开或折叠的折叠形式显示。
viewController	此视图的视图控制器，转换为 BaseListViewController。

构造函数

BaseListView

创建一个具有所有默认属性的 BaseListView。必须设置 BaseVerticalCollectionView.itemsSource 才能使 BaseListView 正确运行。

公共方法

SetViewController

为该视图分配视图控制器，并注册其正常运行所需的所有事件。

事件

itemsAdded	此事件在添加到 itemsSource 的每个项目上调用。包括项目索引。
itemsRemoved	此事件在从 itemsSource 中删除的每个项目上调用。包括项目索引。

继承成员

静态属性

borderUssClassName	具有边框的 BaseVerticalCollectionView 元素的 USS 类名。
dragHoverBarUssClassName	拖动悬停栏的 USS 类名。
dragHoverMarkerUssClassName	用于指示深度的拖动悬停圆形标记的 USS 类名。
itemAlternativeBackgroundUssClassName	BaseVerticalCollectionView 中奇数行的 USS 类名。
itemDragHoverUssClassName	拖动悬停时应用于项目元素的 USS 类名。
itemSelectedVariantUssClassName	BaseVerticalCollectionView 中选定项目元素的 USS 类名。
itemUssClassName	BaseVerticalCollectionView 元素中项目元素的 USS 类名。
listScrollViewUssClassName	BaseVerticalCollectionView 中滚动视图的 USS 类名。
ussClassName	BaseVerticalCollectionView 元素的 USS 类名。
disabledUssClassName	本地禁用元素的 USS 类名。

属性

contentContainer	返回 BaseVerticalCollectionView 的内容容器。由于 BaseVerticalCollectionView 控件自动管理其内容，因此始终返回 null。
fixedItemHeight	列表中单个项目的高度（以像素为单位）。
horizontalScrollingEnabled	此属性控制当集合视图的内容不适合可见区域时是否显示水平滚动条。
itemsSource	集合项目的的数据源。
reorderable	获取或设置一个值，该值指示用户是否可以拖动列表项以重新排序它们。
selectedIds	返回数据源中选定项目的持久 ID，无论它们是否已折叠。始终返回可枚举对象，即使没有选择任何项目或仅选择一个项目。
selectedIndex	返回或设置选定项目的索引（在数据源中）。如果选择了多个项目，则返回第一个选定项目的索引。如果提供了多个项目，则将它们全部设置为已选中。
selectedIndices	返回数据源中选定项目的索引。始终返回可枚举对象，即使没有选择任何项目或仅选择一个项目。
selectedItem	返回数据源中的选定项目。如果选择了多个项目，则返回第一个选定项目。
selectedItems	返回数据源中的选定项目。始终返回可枚举对象，即使没有选择任何项目或仅选择一个项目。
selectionType	控制选择类型。
showAlternatingRowBackgrounds	此属性控制集合视图行的背景颜色是否交替。从 AlternatingRowBackground 枚举中获取值。
showBorder	启用此属性可在集合视图周围显示边框。
viewController	此视图的视图控制器。
virtualizationMethod	当滚动条可见时，此集合要使用的虚拟化方法。从 CollectionVirtualizationMethod 枚举中获取值。
binding	将更新的绑定对象。
bindingPath	要绑定的目标属性的路径。
canGrabFocus	如果元素可以聚焦，则返回 true。
delegatesFocus	元素是否应将其焦点委派给其子元素。
focusable	如果元素可以聚焦，则为 true。
focusController	返回此元素的焦点控制器。
tabIndex	用于在焦点环中对可聚焦元素进行排序的整数。必须大于或等于零。
childCount	此对象的 contentContainer 中子元素的数量。
contentRect	元素内容区域的矩形，位于元素的本地空间中。（只读）
customStyle	VisualElement 的自定义样式属性访问器（只读）。
dataSource	为该 VisualElement 分配数据源，该数据源会覆盖任何继承的数据源。此数据源由所有子元素继承。
dataSourcePath	从数据源到值的路径。
dataSourceType	可以分配给该 VisualElement 的数据源的可能类型。此信息仅由 UI 生成器用作提示，以便在设计时无法指定有效数据源时为数据源路径字段提供一些完成。
disablePlayModeTint	除非将其设置为 true，否则默认情况下会应用播放模式色调。它会分层应用于此 VisualElement 及其在编辑器面板上存在的子元素。
enabledInHierarchy	如果 VisualElement 在其自己的层次结构中已启用，则返回 true。
enabledSelf	如果 VisualElement 在本地已启用，则返回 true。
experimental	返回 UIElements 实验性接口。
generateVisualContent	用于生成视觉元素的视觉内容的委托函数。
hierarchy	访问此元素的物理层次结构。
languageDirection	指示元素文本的方向性。该值将传播到元素的子元素。
layout	VisualElement 相对于其父元素的位置和大小，由布局系统计算。（只读）
localBound	返回一个 Rect，表示应用转换后但在应用布局平移之前，轴对齐的边界框 (AABB)。
name	此 VisualElement 的名称。
paddingRect	元素填充区域的矩形，位于元素的本地空间中。
panel	附加此 VisualElement 的面板。
parent	此 VisualElement 的父元素。
pickingMode	确定此元素是否可以在 mouseEvents 或 IPanel.Pick 查询期间被拾取。
resolvedStyle	视觉元素的最终渲染样式值，如当前帧中渲染的那样。（只读）
scaledPixelsPerPoint	返回面板中考虑屏幕 DPI 和可自定义缩放因子，但不考虑元素及其祖先的变换缩放的最终缩放比例。请参阅 Panel.scaledPixelsPerPoint。这应该只在属于面板的元素上调用。
调度	检索此 VisualElement 的 IVisualElementScheduler
样式	在 VisualElement 上设置样式值。
样式表	返回一个 VisualElementStyleSheetSet，它操作附加到此元素的样式表。
this[int]	检索特定索引处的子元素。
工具提示	在用户将鼠标悬停在元素上一段时间后，在信息框内显示的文本。这仅在编辑器 UI 中受支持。
变换	返回此 VisualElement 的变换对象。ITransform
使用提示	指定 VisualElement 高级预期使用模式的提示值组合。此属性仅可在 VisualElement 尚未成为面板的一部分时设置。一旦成为面板的一部分，此属性实际上就成为只读属性，尝试更改它将引发异常。正确 UsageHints 的规范驱动系统更好地决定如何根据预期的使用模式处理或加速某些操作。请注意，这些提示不会影响行为或视觉结果，只会影响面板和其中元素的整体性能。建议始终考虑指定正确的 UsageHints，但请记住，在某些情况下，某些 UsageHints 可能会在内部被忽略（例如，由于目标平台上的硬件限制）。
用户数据	此属性可用于将应用程序特定的用户数据与此 VisualElement 关联。
视图数据键	用于视图数据持久性，例如树展开状态、滚动位置或缩放级别。
可见	指示是否应渲染此元素。
视觉树资源源	存储资源引用，如果生成的元素是从 VisualTreeAsset 克隆的。
世界边界	返回一个表示应用世界变换后的轴对齐包围盒 (AABB) 的矩形。
世界变换	返回累积以下操作的矩阵（按顺序）：-局部缩放 -局部旋转 -局部平移 -布局平移 -父世界变换（递归定义 - 当没有父级时考虑恒等式）

公共方法

添加到选择	将项目添加到选定项目的集合中。
清除选择	取消选择所有选定的项目。
获取指定 ID 的根元素	获取指定集合视图项目的根元素。
获取指定索引的根元素	获取指定集合视图项目的根元素。
重建	清除集合视图，重新创建所有可见的视觉元素，并重新绑定所有项目。
刷新项目	如果项目当前在集合视图中可见，则重新绑定单个项目。
刷新项目	重新绑定所有当前可见的项目。
从选择中移除	从选定项目的集合中移除项目。
滚动到	滚动到特定的 VisualElement。
滚动到项目	滚动到特定项目索引并使其可见。
滚动到项目 ID	滚动到特定项目 ID 并使其可见。
设置选择	设置当前选定的项目。
在不通知的情况下设置选择	设置选定项目的集合，而不会触发选择更改回调。
是否有冒泡处理程序	如果事件传播冒泡阶段的事件处理程序已附加到此对象，则返回 true。
是否有向下传递处理程序	如果事件处理程序（对于事件传播向下传递阶段）附加到此对象，则返回 true。
注册回调	向实例添加事件处理程序。如果事件处理程序已为同一阶段（向下传递或冒泡）注册，则此方法无效。
注册一次回调	向实例添加事件处理程序。如果事件处理程序已为同一阶段（向下传递或冒泡）注册，则此方法无效。事件处理程序在精确调用一次后自动取消注册。
取消注册回调	从实例中移除回调。
失焦	告诉元素释放焦点。
聚焦	尝试将焦点赋予此元素。
添加	将元素添加到此元素的 contentContainer
添加到类列表	向元素的类列表添加一个类，以便从 USS 分配样式。请注意，类名区分大小写。
置于最前	将此元素置于其父级子级列表的末尾。该元素将在视觉上位于任何重叠的同级元素之前。
子元素	返回其 contentContainer 中的元素。
类列表是否包含	在此元素的类列表中搜索类。
清除	从此元素的 contentContainer 中移除所有子元素
清除绑定	从元素中移除绑定。
清除绑定	从元素中移除所有绑定。
清除类列表	从此元素的类列表中移除所有类。AddToClassList
包含	检查此元素是否是指定子元素的祖先。
包含点	检查指定点是否与此 VisualElement 的布局相交。
元素位于	检索特定索引处的子元素。
在类列表中启用	启用或禁用具有给定名称的类。
查找祖先用户数据	向上搜索此 VisualElement 的层次结构，并检索存储的用户数据（如果找到）。
查找公共祖先	查找 VisualTree 层次结构中两个 VisualElement 之间的最低公共祖先。
获取绑定	获取提供的目标属性的绑定实例。
获取绑定信息	获取当前元素所有绑定的信息。
获取类	检索此元素的类。
获取数据源上下文	查询绑定对象的 dataSource 和 dataSourcePath。
获取第一个祖先类型	向上遍历层次结构，从此元素的父级开始，并返回此类型的第一个 VisualElement
获取第一个类型	向上遍历层次结构，从此元素开始，并返回此类型的第一个 VisualElement
获取分层数据源上下文	查询从层次结构继承的 dataSource 和 dataSourcePath。
是否有绑定	允许知道目标属性是否与其关联的绑定。
索引	检索指定 VisualElement 的子级索引。
插入	将元素插入此元素的 contentContainer
标记脏重绘	在下一帧触发 VisualElement 的重绘。当发生需要重绘的更改时，此方法在内部调用，例如当 UIElements.BaseField_1.value 更改或 Label 中的文本更改时。如果您正在实现自定义控件，则可以在发生需要重绘的更改时调用此方法以触发重绘，例如当使用 generateVisualContent 渲染网格且网格数据现在已更改时。
置于后	将此元素置于其父级子级列表中同级元素的正前方。如果元素和同级元素的位置重叠，则该元素将在视觉上位于其同级元素之后。
置于前	将此元素置于其父级子级列表中同级元素的正后方。如果元素和同级元素的位置重叠，则该元素将在视觉上位于其同级元素之前。
移除	从此 contentContainerhierarchy 中移除此子级。
移除位于	从此元素的 contentContainer 中移除位于此位置的子元素
从类列表中移除	从元素的类列表中移除类。
从层次结构中移除	从此元素的父级层次结构中移除此元素。
发送事件	将事件发送到事件处理程序。
置于最后	将此元素发送到其父级子级列表的开头。该元素将在视觉上位于任何重叠的同级元素之后。
设置绑定	在目标和源之间分配绑定。
设置启用	更改 VisualElement 的启用状态。禁用的 VisualElement 不会接收大多数事件。
排序	重新排序从此 VisualElement contentContainer 中的子元素。
在类列表中切换	在将给定的类名添加到类列表和从中移除之间切换。
尝试获取绑定	获取提供的目标属性的绑定实例。
尝试获取数据源上下文	查询绑定对象的 dataSource 和 dataSourcePath。
尝试获取最后一个绑定到源的结果	返回从 UI 到数据源的绑定对象的最后一个 BindingResult。
尝试获取最后一个绑定到 UI 的结果	返回从数据源到 UI 的绑定对象的最后一个 BindingResult。

受保护的方法

创建视图控制器	为该视图创建视图控制器。在继承者中重写此方法以更改控制器类型。
处理事件冒泡	在冒泡阶段在此元素上执行逻辑，在此元素的冒泡回调之前立即执行。调用 StopPropagation 将阻止沿传播路径进一步调用此方法。
处理事件向下传递	在此元素的向下传递阶段在此元素上执行逻辑，在此元素的向下传递回调之后立即执行。调用 StopPropagation 将阻止沿传播路径进一步调用此方法。
通知属性更改	通知数据绑定系统控件的属性已更改。

事件

可以开始拖动	当拖动操作想要在此集合视图中开始时调用。
拖放更新	当拖动操作在此集合视图中更新时调用。
处理放下	当拖动操作在此集合视图中释放时调用。
项目索引已更改	当项目在 itemsSource 中移动时调用。
项目已选择	当用户对一个或多个项目的选定内容采取操作时触发的回调，例如双击或按 Enter 键。
itemsSource 已更改	当垂直集合视图的数据源被分配新的引用或新类型时引发。
onItemsChosen	已弃用。请改用 BaseVerticalCollectionView.itemsChosen。
onSelectedIndicesChange	已弃用。请改用 BaseVerticalCollectionView.selectedIndicesChanged。
onSelectionChange	已弃用。请改用 BaseVerticalCollectionView.selectionChanged。
selectedIndicesChanged	当选择更改时触发的回调。
selectionChanged	当选择更改时触发的回调。
设置拖放	当拖动操作在此集合视图中开始时调用。

此处描述的内容是否未按预期工作？它可能是一个已知问题。请查看 Issue Tracker 位于 issuetracker.unity3d.com.

脚本 API

BaseListView

成功！

提交失败

描述

静态属性

属性

构造函数

公共方法

事件

继承成员

静态属性

属性

公共方法

受保护的方法

事件