Toggle

Toggle 包括图像和标签。就像其他标准__ UI__（即用户界面，User Interface）让用户能够与您的应用程序进行交互。Unity 目前支持三种 UI 系统。更多信息
See in Glossary 工具包控件（例如 Button）一样，Toggle 附加了一个 Clickable 操控器，可注册到 MouseUpEvent 和 PointerUpEvent。当这些事件之一触发操控器时，Toggle 的值从 true 更改为 false 或从 false 更改为 true。您可以读取或设置 Toggle 的当前值。还可以将 Toggle 绑定到 Boolean 变量。

您可以根据其他条件显示或隐藏元素，例如从下拉选单中进行选择或启用选项。条件 UI 的一个示例是 Unity 摄像机 Inspector。当您激活 Physical Camera 模式，它会显示其他选项。

注意：要将元素与检视面板 (Inspector) 窗口中的其他字段对齐，只需对其应用 .unity-base-field__aligned USS 类。有关更多信息，请参阅 BaseField。

创建 Toggle

您可以使用 UI Builder、UXML 或 C# 创建 Toggle。

以下 C# 示例将创建具有特定标签的 Toggle：

Toggle myToggle = new Toggle("Click me");

设置 Toggle 样式

默认情况下，Toggle 控件显示为一个复选框。您可以应用样式使其看起来像典型的切换开关。

要设置 Toggle 复选框的样式，请使用 .unity-toggle__input 和 .unity-toggle__checkmark style 属性。例如，如果将名为 className 的类应用于 Toggle。选择或清除 Toggle 时，以下 USS 会更改复选框的背景图像：

/* Set the background image when the checkbox is selected. */
.className:checked > .unity-toggle__input > .unity-toggle__checkmark {
    background-image: url("path/to/image-file");
}

/* Set the background image When the checkbox is not selected. */
.className > .unity-toggle__input > .unity-toggle__checkmark {
    background-image: url("path/to/image-file"); 
}

示例

以下 UXML 示例将创建一个 Toggle：

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

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

/// <sample>
// Get a reference to the field from UXML and assign a value to it.
var uxmlField = container.Q<Toggle>("the-uxml-field");
uxmlField.value = true;

// Create a new field, disable it, and give it a style class.
var csharpField = new Toggle("C# Field");
csharpField.value = false;
csharpField.SetEnabled(false);
csharpField.AddToClassList("some-styled-field");
csharpField.value = uxmlField.value;
container.Add(csharpField);

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

要在 Unity 中实时试用此示例，请转到窗口 (Window) > UI 工具包 (UI Toolkit) > 示例 (Samples)。

有关更多示例，请参阅以下内容：

• 创建条件 UI。

C# 基类和命名空间

C# 类：Toggle
命名空间：UnityEngine.UIElements
基类：BaseBoolField

继承 UXML 属性

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

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

USS 类

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

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

其他资源

• Foldout
• 伪类