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

EnumField

UnityEngine.UIElements 中的类

/

继承自:UIElements.BaseField_1

/

实现于:UnityEngine.UIElementsModule

建议更改

成功!

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

关闭

提交失败

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

关闭

取消

描述

创建一个下拉菜单,用于在枚举值之间切换。有关更多信息,请参考 UIE-uxml-element EnumField

静态属性

arrowUssClassName此类型元素中箭头指示器的 USS 类名称。
inputUssClassName此类型元素中输入元素的 USS 类名称。
labelUssClassName此类型元素中标签的 USS 类名称。
textUssClassName此类型元素中文本元素的 USS 类名称。
ussClassName此类型元素的 USS 类名称。

属性

text返回当前选定枚举的文本值。

构造函数

EnumField构造一个 EnumField。

公共方法

Init使用默认值初始化 EnumField,并初始化其底层类型。

继承的成员

静态属性

alignedFieldUssClassName在检查器元素中对齐的元素的 USS 类名称
inputUssClassName此类型元素中输入元素的 USS 类名称。
labelDraggerVariantUssClassName此类型元素中标签的 USS 类名称,当标签上附加了拖动器时。
labelUssClassName此类型元素中标签的 USS 类名称。
mixedValueLabelUssClassName显示混合值的元素的 USS 类名称
noLabelVariantUssClassName此类型元素的 USS 类名称,当没有标签时。
ussClassName此类型元素的 USS 类名称。
disabledUssClassName本地禁用元素的 USS 类名称。

属性

label表示字段旁边将出现的标签的字符串。
labelElement这是出现在字段输入旁边的标签对象。
mixedValueLabel只读标签,用于呈现编辑多个不同值的视觉效果。
rawValue元素的值。
showMixedValue设置为 true 时,会使字段呈现出编辑多个不同值的视觉效果。
value与字段关联的值。
binding将更新的绑定对象。
bindingPath要绑定的目标属性的路径。
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指示元素文本的方向性。该值将传播到元素的子元素。
layoutVisualElement 相对于其父元素的位置和大小,由布局系统计算。(只读)
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用于视图数据持久性,例如树展开状态、滚动位置或缩放级别。
visible指示此元素是否应呈现。
visualTreeAssetSource存储资产引用(如果生成的元素是从 VisualTreeAsset 克隆的)。
worldBound返回一个 Rect,表示应用世界变换后的轴对齐包围盒 (AABB)。
worldTransform返回一个矩阵,它累积以下操作(按顺序):-局部缩放-局部旋转-局部平移-布局平移-父级 worldTransform(递归定义-在没有父级时考虑单位矩阵)

公共方法

SetValueWithoutNotify允许设置值,而不会在有任何更改时收到通知。
HasBubbleUpHandlers如果事件传播的 BubbleUp 阶段的事件处理程序已附加到此对象,则返回 true。
HasTrickleDownHandlers如果事件传播的 TrickleDown 阶段的事件处理程序已附加到此对象,则返回 true。
RegisterCallback向实例添加事件处理程序。如果事件处理程序已为同一阶段(TrickleDown 或 BubbleUp)注册,则此方法无效。
RegisterCallbackOnce向实例添加事件处理程序。如果事件处理程序已为同一阶段(TrickleDown 或 BubbleUp)注册,则此方法无效。事件处理程序在被调用 exactly once 后会自动注销。
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 层次结构中,查找两个 VisualElement 之间的最低共同祖先。
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。

受保护的方法

UpdateMixedValueContent根据 showMixedValue 更新字段的视觉内容。
HandleEventBubbleUp在 BubbleUp 阶段执行此元素上的逻辑,就在此元素的 BubbleUp 回调之前。调用 StopPropagation 将阻止在此传播路径上进一步调用此方法。
HandleEventTrickleDown在 TrickleDown 阶段执行此元素上的逻辑,就在此元素的 TrickleDown 回调之后。调用 StopPropagation 将阻止在此传播路径上进一步调用此方法。
NotifyPropertyChanged通知数据绑定系统控件的属性已更改。