BaseVerticalCollectionView

类在 UnityEngine.UIElements 中

继承自:UIElements.BindableElement

实现于:UnityEngine.UIElementsModule

留下反馈

实现接口:ISerializationCallbackReceiver

建议更改

描述

用于在滚动视图中显示虚拟化垂直内容的控件的基类。

静态属性

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

属性

contentContainer	返回 BaseVerticalCollectionView 的内容容器。因为 BaseVerticalCollectionView 控件会自动管理其内容，所以始终返回 null。
fixedItemHeight	列表中单个项目的以像素为单位的高度。
horizontalScrollingEnabled	此属性控制集合视图在内容不适合可见区域时是否显示水平滚动条。
itemsSource	集合项目的數據源。
reorderable	获取或设置一个值，该值指示用户是否可以拖动列表项以重新排序。
selectedIds	返回数据源中选中项目的持久 ID，无论它们是否已折叠。始终返回一个可枚举对象，即使没有选中项目或仅选中一个项目。
selectedIndex	返回或设置数据源中选中项目的索引。如果选中多个项目，则返回第一个选中项目的索引。如果提供了多个项目，则将它们全部设置为选中状态。
selectedIndices	返回数据源中选中项目的索引。始终返回一个可枚举对象，即使没有选中项目或仅选中一个项目。
selectedItem	返回数据源中的选中项目。如果选中多个项目，则返回第一个选中项目。
selectedItems	返回数据源中的选中项目。始终返回一个可枚举对象，即使没有选中项目或仅选中一个项目。
selectionType	控制选择类型。
showAlternatingRowBackgrounds	此属性控制集合视图行是否交替显示背景颜色。从 AlternatingRowBackground 枚举中获取一个值。
showBorder	启用此属性以在集合视图周围显示边框。
viewController	此视图的视图控制器。
virtualizationMethod	滚动条可见时，此集合要使用的虚拟化方法。从 CollectionVirtualizationMethod 枚举中获取一个值。

构造函数

BaseVerticalCollectionView

使用所有默认属性创建 BaseVerticalCollectionView。必须为 BaseVerticalCollectionView 设置 BaseVerticalCollectionView.itemsSource，才能使 BaseVerticalCollectionView 正确运行。

公共方法

AddToSelection	将项目添加到选中项目的集合中。
ClearSelection	取消选中所有选定的项目。
GetRootElementForId	获取指定集合视图项目的根元素。
GetRootElementForIndex	获取指定集合视图项目的根元素。
Rebuild	清除集合视图，重新创建所有可见的可视元素，并重新绑定所有项目。
RefreshItem	如果单个项目当前在集合视图中可见，则重新绑定该项目。
RefreshItems	重新绑定所有当前可见的项目。
RemoveFromSelection	从选中项目的集合中移除项目。
ScrollTo	滚动到特定 VisualElement。
ScrollToItem	滚动到特定项目索引并使其可见。
ScrollToItemById	滚动到特定项目 ID 并使其可见。
SetSelection	设置当前选定的项目。
SetSelectionWithoutNotify	设置一组选定项目，而不会触发选择更改回调。
SetViewController	为此视图分配视图控制器，并注册使其正常运行所需的所有事件。

受保护的方法

CreateViewController

创建此视图的视图控制器。在继承者中重写此方法以更改控制器类型。

事件

canStartDrag	当拖动操作想要在此集合视图中开始时调用。
dragAndDropUpdate	当拖动操作在此集合视图中更新时调用。
handleDrop	当拖动操作在此集合视图中释放时调用。
itemIndexChanged	当项目在 itemsSource 中移动时调用。
itemsChosen	当用户对一个或多个项目的选定进行操作时触发的回调，例如双击或按 Enter 键。
itemsSourceChanged	当垂直集合视图的数据源被分配新引用或新类型时引发。
onItemsChosen	已弃用。使用 BaseVerticalCollectionView.itemsChosen 代替。
onSelectedIndicesChange	已弃用。使用 BaseVerticalCollectionView.selectedIndicesChanged 代替。
onSelectionChange	已弃用。使用 BaseVerticalCollectionView.selectionChanged 代替。
selectedIndicesChanged	当选择发生更改时触发的回调。
selectionChanged	当选择发生更改时触发的回调。
setupDragAndDrop	当拖动操作在此集合视图中开始时调用。

继承的成员

静态属性

disabledUssClassName

本地禁用元素的 USS 类名。

属性

binding	将要更新的绑定对象。
bindingPath	要绑定的目标属性的路径。
canGrabFocus	如果元素可以获得焦点，则返回 true。
delegatesFocus	元素是否应将其焦点委托给其子元素。
focusable	如果元素可以获得焦点，则为 true。
focusController	返回此元素的焦点控制器。
tabIndex	用于在焦点环中对可聚焦项进行排序的整数。必须大于或等于零。
childCount	此对象的 contentContainer 中的子元素数量。
contentContainer	子元素被添加到其中，通常与元素本身相同。
contentRect	元素内容区域的矩形，在元素的本地空间中。（只读）
customStyle	VisualElement 的自定义样式属性访问器。（只读）
dataSource	将数据源分配给此 VisualElement，它会覆盖任何继承的数据源。此数据源由所有子元素继承。
dataSourcePath	从数据源到值的路径。
dataSourceType	可以分配给此 VisualElement 的数据源的可能类型。此信息仅由 UI Builder 使用，作为提示，在设计时无法指定有效数据源时，为数据源路径字段提供一些完成提示。
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	确定此元素是否可以在鼠标事件或 IPanel.Pick 查询期间选中。
resolvedStyle	可视元素的最终渲染样式值，如当前帧中渲染的那样。（只读）
scaledPixelsPerPoint	返回来自面板的结果缩放比例，该缩放比例考虑屏幕 DPI 和可自定义的缩放系数，但不考虑元素及其祖先的变换缩放比例。请参见 Panel.scaledPixelsPerPoint。这仅应在属于面板的元素上调用。
schedule	检索此 VisualElement 的 IVisualElementScheduler
style	在 VisualElement 上设置样式值。
styleSheets	返回 VisualElementStyleSheetSet，用于操作附加到此元素的样式表。
this[int]	检索特定索引处的子元素。
tooltip	在用户将鼠标悬停在元素上一段时间后，将在信息框中显示的文本。这仅在编辑器 UI 中受支持。
transform	返回此 VisualElement 的变换对象。ITransform
usageHints	提示值的组合，指定 VisualElement 的高级预期使用模式。此属性只能在 VisualElement 尚未成为面板的一部分时设置。一旦成为面板的一部分，此属性将实际上变为只读，尝试更改它将引发异常。正确 UsageHints 的规范会驱动系统根据预期的使用模式，更好地决定如何处理或加速某些操作。请注意，这些提示不会影响行为或视觉结果，而只会影响面板及其内部元素的整体性能。建议始终考虑指定正确的 UsageHints，但请记住，某些 UsageHints 在某些条件下可能会被内部忽略（例如，由于目标平台上的硬件限制）。
userData	此属性可用于将应用程序特定的用户数据与此 VisualElement 相关联。
viewDataKey	用于视图数据持久性，例如树展开状态、滚动位置或缩放级别。
可见	指示此元素是否应渲染。
visualTreeAssetSource	如果生成的元素是从 VisualTreeAsset 克隆的，则存储资产引用。
worldBound	返回一个 Rect，表示应用世界变换后的轴对齐包围盒 (AABB)。
worldTransform	返回一个矩阵，该矩阵累积以下操作（按顺序）：-本地缩放 -本地旋转 -本地平移 -布局平移 -父 worldTransform（递归定义 - 在没有父级时考虑身份）

公共方法

HasBubbleUpHandlers	如果事件传播 BubbleUp 阶段的事件处理程序已附加到此对象，则返回 true。
HasTrickleDownHandlers	如果事件传播 TrickleDown 阶段的事件处理程序已附加到此对象，则返回 true。
RegisterCallback	向实例添加事件处理程序。如果事件处理程序已针对同一阶段（TrickleDown 或 BubbleUp）注册，则此方法无效。
RegisterCallbackOnce	向实例添加事件处理程序。如果事件处理程序已针对同一阶段（TrickleDown 或 BubbleUp）注册，则此方法无效。事件处理程序在恰好调用一次后会自动取消注册。
UnregisterCallback	从实例中删除回调。
模糊	告诉元素释放焦点。
焦点	尝试将焦点赋予此元素。
添加	将元素添加到此元素的 contentContainer 中。
AddToClassList	向元素的类列表添加一个类，以便从 USS 分配样式。请注意，类名区分大小写。
BringToFront	将此元素置于其父级子级列表的末尾。该元素将在视觉上位于任何重叠的同级元素的前面。
儿童	返回其 contentContainer 中的元素。
ClassListContains	在此元素的类列表中搜索一个类。
清除	从此元素的 contentContainer 中删除所有子元素。
ClearBinding	从元素中删除绑定。
ClearBindings	从元素中删除所有绑定。
ClearClassList	从此元素的类列表中删除所有类。AddToClassList
包含	检查此元素是否是指定子元素的祖先。
ContainsPoint	检查指定点是否与此 VisualElement 的布局相交。
ElementAt	检索特定索引处的子元素。
EnableInClassList	启用或禁用具有给定名称的类。
FindAncestorUserData	向上搜索此 VisualElement 的层次结构，并检索存储的 userData（如果有）。
FindCommonAncestor	在 VisualTree 层次结构中查找两个 VisualElements 之间的最低共同祖先。
GetBinding	获取为提供的目标属性提供的绑定实例。
GetBindingInfos	获取有关当前元素的所有绑定的信息。
GetClasses	检索此元素的类。
GetDataSourceContext	查询绑定对象的 dataSource 和 dataSourcePath。
GetFirstAncestorOfType	从此元素的父级开始向上遍历层次结构，并返回此类型的第一个 VisualElement。
GetFirstOfType	从此元素开始向上遍历层次结构，并返回此类型的第一个 VisualElement。
GetHierarchicalDataSourceContext	查询从层次结构继承的 dataSource 和 dataSourcePath。
HasBinding	允许知道目标属性是否与之关联的绑定。
IndexOf	检索指定 VisualElement 的子级索引。
插入	将元素插入此元素的 contentContainer 中。
MarkDirtyRepaint	在下一帧触发 VisualElement 的重绘。当发生需要重绘的更改时，此方法在内部调用，例如当 UIElements.BaseField_1.value 更改或 Label 中的文本更改时。如果要实现自定义控件，则可以在发生需要重绘的更改时（例如在使用 generateVisualContent 渲染网格并且网格数据现在已更改时）调用此方法以触发重绘。
PlaceBehind	将此元素置于其同级元素之前，在其父级子级列表中。如果元素和同级元素的位置重叠，则元素将在视觉上位于其同级元素的后面。
PlaceInFront	将此元素置于其同级元素之后，在其父级子级列表中。如果元素和同级元素的位置重叠，则元素将在视觉上位于其同级元素的前面。
删除	从 contentContainer 层次结构中删除此子级。
RemoveAt	从此元素的 contentContainer 中删除位于此位置的子元素。
RemoveFromClassList	从元素的类列表中删除一个类。
RemoveFromHierarchy	从此元素的父级层次结构中删除此元素。
SendEvent	将事件发送到事件处理程序。
SendToBack	将此元素发送到其父级子级列表的开头。该元素将在视觉上位于任何重叠的同级元素的后面。
SetBinding	在目标和源之间分配绑定。
SetEnabled	更改 VisualElement 的启用状态。禁用的 VisualElement 不会接收大多数事件。
排序	重新排列从此 VisualElement contentContainer 中的子元素。
ToggleInClassList	在将给定类名添加到类列表和从类列表中删除给定类名之间切换。
TryGetBinding	获取为提供的目标属性提供的绑定实例。
TryGetDataSourceContext	查询绑定对象的 dataSource 和 dataSourcePath。
TryGetLastBindingToSourceResult	返回从 UI 到数据源的绑定对象的最后一个 BindingResult。
TryGetLastBindingToUIResult	返回从数据源到 UI 的绑定对象的最后一个 BindingResult。

受保护的方法

HandleEventBubbleUp	在 BubbleUp 阶段在此元素上执行逻辑，立即在此元素的 BubbleUp 回调之前。调用 StopPropagation 将阻止沿传播路径进一步调用此方法。
HandleEventTrickleDown	在 TrickleDown 阶段在此元素上执行逻辑，立即在此元素的 TrickleDown 回调之后。调用 StopPropagation 将阻止沿传播路径进一步调用此方法。
NotifyPropertyChanged	通知数据绑定系统控件的属性已更改。

此处描述的某些内容是否未按预期工作？它可能是已知问题。请查看问题跟踪器，网址为 issuetracker.unity3d.com.

脚本 API

BaseVerticalCollectionView

成功！

提交失败

描述

静态属性

属性

构造函数

公共方法

受保护的方法

事件

继承的成员

静态属性

属性

公共方法

受保护的方法