版本:Unity 6 (6000.0)
语言英语
  • C#

Tab

UnityEngine.UIElements 中的类

/

继承自:UIElements.VisualElement

/

实现于:UnityEngine.UIElementsModule

建议更改

成功!

感谢您帮助我们提高 Unity 文档的质量。虽然我们无法接受所有提交的内容,但我们会阅读用户提出的每个建议更改,并在适用的情况下进行更新。

关闭

提交失败

由于某种原因,您的建议更改无法提交。请<a>稍后再试</a>。感谢您抽出时间帮助我们提高 Unity 文档的质量。

关闭

取消

描述

创建一个标签来组织不同屏幕上的内容。

标签有一个标题,可以响应指针和鼠标事件。标题可以包含图标、标签或两者。标签内容容器可以容纳任何内容,从而为自定义其布局提供了更大的灵活性。

有关更多信息,请参阅UXML 元素标签

静态属性

closeableUssClassName可关闭标签的 USS 类名。
closeButtonUssClassName可关闭标签中关闭按钮的 USS 类名。
contentUssClassName此类型的容器元素的 USS 类名。
draggingUssClassName此类型的拖动状态的 USS 类名。
reorderableItemHandleBarUssClassName可重新排序标签中拖动控制杆的 USS 类名。
reorderableItemHandleUssClassName可重新排序标签中拖动手柄的 USS 类名。
reorderableUssClassName可重新排序标签元素的 USS 类名。
tabHeaderEmptyImageUssClassName当值为 null 时,标题内图标的 USS 类名。
tabHeaderEmptyLabeUssClassName当值为空或为 null 时,标题标签的 USS 类名。
tabHeaderImageUssClassName标题内图标的 USS 类名。
tabHeaderLabelUssClassName标题标签的 USS 类名。
tabHeaderStandaloneImageUssClassName当标签为空或为 null 时,标题内图标的 USS 类名。
tabHeaderUnderlineUssClassName标题活动状态下划线的 USS 类名。
tabHeaderUssClassName此类型的标题的 USS 类名。
ussClassName此类型元素的 USS 类名。

属性

closeable一个添加关闭标签功能的属性。
contentContainer标签内容的容器。
iconImage设置标签标题的图标。
label设置标签标题的标签。
tabHeader返回标签的标题。

构造函数

Tab构造一个标签。

事件

closed当标签被关闭时,此事件被调用。
closing在标签被关闭之前,此事件被调用。如果标签可以被关闭,则返回 true。
selected当标签被选中时,此事件被调用。

继承的成员

静态属性

disabledUssClassName本地禁用元素的 USS 类名。

属性

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

公共方法

HasBubbleUpHandlers如果事件传播 BubbleUp 阶段的事件处理程序已附加到此对象,则返回 true。
HasTrickleDownHandlers如果事件传播 TrickleDown 阶段的事件处理程序已附加到此对象,则返回 true。
RegisterCallback将事件处理程序添加到实例。如果事件处理程序已针对相同的阶段(TrickleDown 或 BubbleUp)注册,则此方法无效。
RegisterCallbackOnce将事件处理程序添加到实例。如果事件处理程序已针对相同的阶段(TrickleDown 或 BubbleUp)注册,则此方法无效。事件处理程序在恰好被调用一次后会自动取消注册。
UnregisterCallback从实例中删除回调。
Blur告诉元素释放焦点。
Focus尝试将焦点赋予此元素。
Add将元素添加到此元素的 contentContainer
AddToClassList向元素的类列表中添加一个类,以从 USS 分配样式。请注意,类名区分大小写。
BringToFront将此元素移至其父元素子元素列表的末尾。该元素将在视觉上位于任何重叠的兄弟元素之前。
Children返回其 contentContainer 中的元素。
ClassListContains在元素的类列表中搜索一个类。
Clear从此元素的 contentContainer 中删除所有子元素
ClearBinding从元素中删除绑定。
ClearBindings从元素中删除所有绑定。
ClearClassList从此元素的类列表中删除所有类。AddToClassList
Contains检查此元素是否是指定子元素的祖先。
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 的子索引。
Insert将元素插入此元素的 contentContainer
MarkDirtyRepaint在下一帧触发 VisualElement 的重绘。当发生需要重绘的更改时,此方法会在内部调用,例如当 UIElements.BaseField_1.value 更改或 Label 中的文本更改时。如果您正在实现自定义控件,则可以在发生需要重绘的更改时调用此方法来触发重绘,例如当使用 generateVisualContent 渲染网格并且网格数据现在已更改时。
PlaceBehind将此元素放置在其父级子项列表中兄弟元素之前。如果元素和兄弟元素的位置重叠,则元素将在视觉上位于其兄弟元素的后面。
PlaceInFront将此元素放置在其父级子项列表中兄弟元素之后。如果元素和兄弟元素的位置重叠,则元素将在视觉上位于其兄弟元素的前面。
Remove从 contentContainer 层次结构中移除此子项。
RemoveAt从此元素的 contentContainer 中移除位于此位置的子元素。
RemoveFromClassList从元素的类列表中移除一个类。
RemoveFromHierarchy从其父级层次结构中移除此元素。
SendEvent将事件发送到事件处理程序。
SendToBack将此元素发送到其父级子项列表的开头。元素将在视觉上位于任何重叠的兄弟元素的后面。
SetBinding在目标和源之间分配绑定。
SetEnabled更改 VisualElement 的启用状态。禁用的 VisualElement 不会接收大多数事件。
Sort重新排序此 VisualElement contentContainer 中的子元素。
ToggleInClassList在将给定的类名添加到类列表和从类列表中移除给定的类名之间切换。
TryGetBinding获取提供的目标属性的绑定实例。
TryGetDataSourceContext查询绑定对象的 dataSource 和 dataSourcePath。
TryGetLastBindingToSourceResult返回从 UI 到数据源的绑定对象的最后一个 BindingResult。
TryGetLastBindingToUIResult返回从数据源到 UI 的绑定对象的最后一个 BindingResult。

受保护方法

HandleEventBubbleUp在冒泡阶段在此元素上执行逻辑,紧接在此元素的冒泡回调之前。调用 StopPropagation 将阻止沿着传播路径进一步调用此方法。
HandleEventTrickleDown在向下过滤阶段在此元素上执行逻辑,紧接在此元素的向下过滤回调之后。调用 StopPropagation 将阻止沿着传播路径进一步调用此方法。
NotifyPropertyChanged通知数据绑定系统控件的属性已更改。