Version: Unity 6.0 (6000.0)
语言 : 中文
FloatField
GradientField

Foldout

Foldout 是__ UI__(即用户界面,User Interface)让用户能够与您的应用程序进行交互。Unity 目前支持三种 UI 系统。更多信息
See in Glossary
的可折叠部分。Foldout 会在单击其标题时隐藏或显示其包含的元素。

Foldout
Foldout

创建 Foldout

Foldout 具有以下元素:

  • 标签:可用于 Foldout 名称的标签。
  • 开关:单击开关以展开或折叠容器子元素。它看起来像一个箭头,而不是默认的复选框。当容器折叠时,箭头指向右侧。当容器展开时,箭头指向下方。
  • 容器:容器包含要在切换 Foldout 时显示或隐藏的视觉元素。

您可以将元素添加到 Foldout 的容器中,show-or-hide 函数会自动工作。

以下 UI 文档将在其容器中创建一个包含两个按钮的 Foldout。切换 Foldout 时,这两个按钮会显示或隐藏。

<ui:UXML xmlns:ui="UnityEngine.UIElements" xmlns:uie="UnityEditor.UIElements" xsi="http://www.w3.org/2001/XMLSchema-instance" engine="UnityEngine.UIElements" editor="UnityEditor.UIElements" noNamespaceSchemaLocation="../../UIElementsSchema/UIElements.xsd" editor-extension-mode="False">
    <ui:Foldout text="Foldout" name="MyFoldout" value="true">
        <ui:Button text="First item" />
        <ui:Button text="Second item" />
    </ui:Foldout>
</ui:UXML>

响应用户操作

Foldout 及其开关子元素响应更改事件。开关隐藏或显示 Foldout 容器。

您可以将 Foldout 绑定到布尔变量,或者通过 INotifyValueChanged<bool> 接口读取其值。

示例

以下 C# 代码片段会创建一个 Foldout 并检查其是否展开:

// Create a new foldout, add two elements to it and add it to the container
var cSharpFoldout = new Foldout {text = "Elements"};
cSharpFoldout.Add(new Label("Indented Label"));
cSharpFoldout.Add(new Slider("Indented Slider", 0, 100));
container.Add(cSharpFoldout);

cSharpFoldout.RegisterValueChangedCallback(e =>
{
    // Check whether the foldout is expanded
    if (cSharpFoldout.value)
    {
        Debug.Log("Foldout is expanded");
    }
    else
    {
        Debug.Log("Foldout is collapsed");
    }
});

C# 基类和命名空间

C# 类Foldout
命名空间UnityEngine.UIElements
基类BindableElement

成员 UXML 属性

此元素具有以下成员属性:

名称 类型 描述
text string 开关的标签文本。
toggle-on-label-click boolean 用户单击标签时是否切换折叠状态。
value boolean 这是折叠 (Foldout) 开关的状态。如果 Foldout 打开且其内容可见,则为 true;如果折叠 (Foldout) 关闭且其内容隐藏,则为 false。

继承 UXML 属性

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

名称 类型 描述
binding-path string 要绑定的目标属性的路径。
focusable boolean 如果元素可以获得焦点,则为 true。
tabindex int 用于对焦点环中可获得焦点的元素排序的整数。必须大于或等于零。

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

名称 类型 描述
content-container string 向其添加子元素,通常与元素本身相同。
data-source Object 为此 VisualElement 分配一个数据源,此数据源将覆盖任何已继承的数据源。此数据源由所有子项继承。
data-source-path string 从数据源到值的路径。
data-source-type System.Type 可分配给此 VisualElement 的可能数据源的类型。

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

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

要增强此属性的 RTL 功能,用户可以在 Unity 资源商店中探索可用的第三方插件,并使用 ITextElementExperimentalFeatures.renderedText
name string 此 VisualElement 的名称。

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

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

USS 类

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

C# 属性 USS 选择器 描述
ussClassName .unity-foldout 折叠 (Foldout) 元素的 USS 类名称。

Unity 将此 USS 类添加到 Foldout 的每个实例。应用于此类的任何样式都会影响位于视觉树中样式表旁边或下方的每个折叠 (Foldout)。
toggleUssClassName .unity-foldout__toggle 折叠 (Foldout) 元素中开关 (Toggle) 子元素的 USS 类名称。

Unity 将此 USS 类添加到每个 FoldoutToggle 子元素。应用于此类的任何样式都会影响位于视觉树中样式表旁边或下方的每个开关 (Toggle) 子元素。
contentUssClassName .unity-foldout__content 折叠 (Foldout) 中内容元素的 USS 类名称。

Unity 将此 USS 类添加到包含要显示或隐藏的元素的 VisualElement 中。应用于此类的任何样式都会影响位于视觉树中样式表旁边或下方的每个折叠容器。
inputUssClassName .unity-foldout__input 折叠 (Foldout) 中标签 (Label) 元素的 USS 类名称。

Unity 将此 USS 类添加到包含 Toggle 输入元素的 VisualElement。应用于此类的任何样式都会影响位于视觉树中样式表旁边或下方的每个折叠容器。
checkmarkUssClassName .unity-foldout__checkmark 折叠 (Foldout) 中标签 (Label) 元素的 USS 类名称。

Unity 将此 USS 类添加到表示每个 Foldout Toggle 子元素的复选标记的 VisualElement 中。应用于此类的任何样式都会影响位于视觉树中样式表旁边或下方的每个折叠容器。
textUssClassName .unity-foldout__text 折叠 (Foldout) 中标签 (Label) 元素的 USS 类名称。

Unity 将此 USS 类添加到每个 FoldoutToggle 子元素中的 Label 中。应用于此类的任何样式都会影响位于视觉树中样式表旁边或下方的每个折叠容器。
disabledUssClassName .unity-disabled 本地被禁用元素的 USS 类名称。

还可以使用检视器中的匹配选择器 (Matching Selectors) 部分或 UI 工具包调试器来查看哪些 USS 选择器在其层级视图的每个级别上影响 VisualElement 的组件。

其他资源

FloatField
GradientField