版本:Unity 6 (6000.0)
语言:English
UXML 元素 DoubleField
UXML 元素 EnumField

UXML 元素 DropdownField

DropdownField 允许用户从列表中选择一个值。单击控件时,它会打开一个抽屉,其中显示多个选项,允许用户选择其中一个。如果要始终显示所有选项,请使用RadioButtonGroup

注意:要使元素与 检视器一个 Unity 窗口,显示有关当前选定游戏对象、资源或项目设置的信息,允许您检查和编辑这些值。更多信息
请参阅词汇表
窗口中的其他字段对齐,只需向其应用.unity-base-field__aligned USS 类。有关更多信息,请参阅BaseField

创建 DropdownField

您可以使用UI(用户界面) 允许用户与您的应用程序交互。Unity 目前支持三种 UI 系统。更多信息
请参阅词汇表
构建器、UXML 或 C# 创建 DropdownField。

UI 构建器

要在 UI 构建器中为 DropdownField 添加选项,请在 DropdownField 的检视器面板中,在选项中输入以逗号分隔的选项。

要设置默认值,请在 DropdownField 的检视器中,在索引中输入选项的编号序列,从0开始。

C#

以下 C# 示例创建了一个带有三个选项的 DropdownField。DropdownField 默认选择第一个选项

var dropdown = new DropdownField("Options", new List<string> { "Option 1", "Option 2", "Option 3" }, 0);

//Add another option
dropdown.choices.Add("Option 4");

// To return int value instead of string
dropdown.index = 1; // Option 2
dropdown.value = "Option3";
Assert.IsTrue(myDropdown.index == 2);

// Register to the value changed callback
dropdown.RegisterValueChangedCallback(evt => Debug.Log(evt.newValue));

更改 DropdownField 的样式

您可以覆盖 USS 文件中的默认面板设置字段以更改 DropdownField 的样式

  1. 层次结构窗口中,选择您的 UI 文档 (.uxml)。
  2. 面板设置设置为您的面板设置资源。如果您没有现有的面板设置资源,请按照对话框中的说明创建一个。
  3. 在您的面板设置资源中,分配主题样式表
  4. 项目窗口中,选择您的 TSS 文件。
  5. 转到样式表并选择添加+)按钮。
  6. 将您的样式表设置为您的USS 文件

示例

以下 UXML 示例创建了一个 DropdownField

<UXML xmlns="UnityEngine.UIElements" xmlns:uie="UnityEditor.UIElements">
    <DropdownField label="UXML Field" name="the-uxml-field" />
</UXML>

以下 C# 示例说明了 DropdownField 的一些可自定义功能

/// <sample>
// You can provide the list of choices by code, or by comma separated values in UXML
// <DropdownField .... choices="Option 1,Option 2,Option 3" .... />
var choices = new List<string> { "Option 1", "Option 2", "Option 3" };

// Get a reference to the dropdown field from UXML and assign a value to it.
var uxmlField = container.Q<DropdownField>("the-uxml-field");
uxmlField.choices = choices;
uxmlField.value = choices[0];

// Create a new dropdown with the same choices, disable it, and give it a style class.
var csharpField = new DropdownField("C# Field", choices, 0);
csharpField.SetEnabled(false);
csharpField.AddToClassList("some-styled-field");
container.Add(csharpField);

// Mirror the value of the UXML field into the C# field.
uxmlField.RegisterCallback<ChangeEvent<string>>((evt) =>
{
    csharpField.value = evt.newValue;
});
/// </sample>

要在 Unity 中实时尝试此示例,请转到窗口>UI 工具包>示例

C# 基类和命名空间

C# 类DropdownField
命名空间UnityEngine.UIElements
基类PopupField_1

继承的 UXML 属性

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

名称 类型 描述
binding-path 字符串 要绑定的目标属性的路径。
choices IList 要在弹出菜单中显示的选择列表。
focusable 布尔值 如果元素可以聚焦,则为真。
index 整数 弹出菜单中当前选定的索引。设置索引将更新::ref::value字段并发送属性更改通知。
label 字符串 表示将出现在字段旁边的标签的字符串。
tabindex 整数 用于在焦点环中对可聚焦元素进行排序的整数。必须大于或等于零。
value 整数 弹出菜单中当前选定的值。

此元素还从VisualElement继承以下属性

名称 类型 描述
content-container 字符串 子元素添加到其中,通常与元素本身相同。
data-source 对象 为该 VisualElement 分配数据源,该数据源覆盖任何继承的数据源。此数据源由所有子元素继承。
data-source-path 字符串 从数据源到值的路径。
data-source-type System.Type 可分配给此 VisualElement 的数据源的可能类型。

此信息仅供 UI 构建器使用,作为提示,在设计时无法指定有效数据源时,为数据源路径字段提供一些补全。
language-direction UIElements.LanguageDirection 指示元素文本的方向性。该值将传播到元素的子元素。

将 languageDirection 设置为 RTL 通过反转文本并适当地处理换行和自动换行来添加对从右到左 (RTL) 的基本支持。但是,它不提供全面的 RTL 支持,因为这需要文本整形,包括字符的重新排序和 OpenType 字体功能支持。全面的 RTL 支持计划在未来的更新中提供,这将涉及其他 API 来处理语言、脚本和字体功能规范。

为了增强此属性的 RTL 功能,用户可以探索 Unity Asset Store 中可用的第三方插件并使用ITextElementExperimentalFeatures.renderedText
name 字符串 此 VisualElement 的名称。

使用此属性编写针对特定元素的 USS 选择器。标准做法是为元素提供唯一的名称。
picking-mode UIElements.PickingMode 确定此元素是否可以在 mouseEvents 或IPanel.Pick查询期间被拾取。
style 字符串 设置VisualElement样式值。
tooltip 字符串 在用户将鼠标悬停在元素上一段时间后,在信息框内显示的文本。这仅在编辑器 UI 中受支持。
usage-hints UIElements.UsageHints 指定VisualElement的高级预期使用模式的提示值的组合。仅当VisualElement尚未成为Panel的一部分时,才能设置此属性。一旦成为Panel的一部分,此属性实际上就成为只读属性,尝试更改它将引发异常。正确UsageHints的规范会驱动系统根据预期的使用模式做出更好的决策,关于如何处理或加速某些操作。请注意,这些提示不会影响行为或视觉结果,而只会影响面板及其内部元素的整体性能。建议始终考虑指定正确的UsageHints,但请记住,某些UsageHints在某些情况下可能会被内部忽略(例如,由于目标平台上的硬件限制)。
view-data-key 字符串 用于视图数据持久性,例如树展开状态、滚动位置或缩放级别。

此键用于从视图数据存储中保存和加载视图数据。如果您不设置此键,则关联的VisualElement将禁用持久性。有关更多信息,请参阅视图数据持久性

USS 类

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

C# 属性 USS 选择器 描述
ussClassName .unity-popup-field 此类型元素的 USS 类名称。
labelUssClassName .unity-popup-field__label 此类型元素中标签的 USS 类名称。
inputUssClassName .unity-popup-field__input 此类型元素中输入元素的 USS 类名称。
ussClassName .unity-base-popup-field 此类型元素的 USS 类名称。
textUssClassName .unity-base-popup-field__text 此类型元素中文本元素的 USS 类名称。
arrowUssClassName .unity-base-popup-field__arrow 此类型元素中箭头指示器的 USS 类名称。
labelUssClassName .unity-base-popup-field__label 此类型元素中标签的 USS 类名称。
inputUssClassName .unity-base-popup-field__input 此类型元素中输入元素的 USS 类名称。
ussClassName .unity-base-field 此类型元素的 USS 类名称。
labelUssClassName .unity-base-field__label 此类型元素中标签的 USS 类名称。
inputUssClassName .unity-base-field__input 此类型元素中输入元素的 USS 类名称。
noLabelVariantUssClassName .unity-base-field--no-label 当没有标签时,此类型元素的 USS 类名称。
labelDraggerVariantUssClassName .unity-base-field__label--with-dragger 当标签上附加了拖动器时,此类型元素中标签的 USS 类名称。
mixedValueLabelUssClassName .unity-base-field__label--mixed-value 显示混合值的元素的 USS 类名称
alignedFieldUssClassName .unity-base-field__aligned 在检视器元素中对齐的元素的 USS 类名称
disabledUssClassName .unity-disabled 本地禁用元素的 USS 类名称。

您还可以使用检视器或 UI 工具包调试器中的匹配选择器部分来查看哪些 USS 选择器影响其层次结构中每个级别的VisualElement的组件。

其他资源

UXML 元素 DoubleField
UXML 元素 EnumField