版本:Unity 6 (6000.0)
语言:English
UXML 元素 ToolbarSpacer
UXML 元素 TreeView

UXML 元素 ToolbarToggle

ToolbarToggle 是一个仅限编辑器控件,用作工具栏Unity 编辑器顶部的按钮和基本控件行,允许您以各种方式与编辑器交互(例如缩放、平移)。更多信息
请参阅术语表
中的切换按钮。它是一个切换按钮一个复选框,允许用户打开或关闭选项。更多信息
请参阅术语表
,具有与工具栏样式匹配的预定义样式。它看起来像一个可以打开或关闭的按钮。

创建 ToolbarToggle

您可以使用UI(用户界面) 允许用户与您的应用程序交互。Unity 目前支持三种 UI 系统。更多信息
请参阅术语表
构建器、UXML 或 C# 创建 ToolbarToggle。以下 C# 示例创建了一个带标签的 ToolbarToggle

using UnityEditor.UIElements;
...
var toolbarToggle = new ToolbarToggle() { text = "Toggle me" };

C# 基类和命名空间

C# 类ToolbarToggle
命名空间UnityEditor.UIElements
基类Toggle

继承的 UXML 属性

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

名称 类型 描述
binding-path 字符串 要绑定的目标属性的路径。
focusable 布尔值 如果元素可以聚焦,则为真。
label 字符串 表示将在字段旁边显示的标签的字符串。
tabindex 整数 用于在焦点环中对可聚焦元素进行排序的整数。必须大于或等于零。
text 字符串 出现在 BaseBoolField 之后的可选项文本。

如果不存在,Unity 会自动创建一个Label
toggle-on-label-click 布尔值 用户单击标签时是否激活切换按钮。
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 确定此元素在鼠标事件或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-toolbar-toggle 此类型元素的 USS 类名。
ussClassName .unity-toggle Toggle 元素的 USS 类名。

Unity 将此 USS 类添加到 Toggle 元素的每个实例。应用于此类的任何样式都会影响视觉树中样式表旁边或下方的每个 Toggle。
labelUssClassName .unity-toggle__label Toggle 元素中标签的 USS 类名。

如果 Toggle 有标签,Unity 会将此 USS 类添加到ToggleLabel子元素。
inputUssClassName .unity-toggle__input Toggle 元素中输入元素的 USS 类名。

Unity 将此 USS 类添加到Toggle的输入子元素。输入子元素提供对操纵器的响应。
noTextVariantUssClassName .unity-toggle--no-text 没有文本的 Toggle 元素的 USS 类名。

如果 Toggle 没有标签,Unity 会将此 USS 类添加到Toggle
checkmarkUssClassName .unity-toggle__checkmark Toggle 元素中图像的 USS 类名。

Unity 将此 USS 类添加到包含复选标记图像的Toggle的 Image 子元素。
textUssClassName .unity-toggle__text Toggle 元素中文本元素的 USS 类名。

Unity 将此 USS 类添加到Toggle的 Text 子元素。
mixedValuesUssClassName .unity-toggle__mixed-values 具有混合值的 Toggle 元素的 USS 类名

Toggle具有混合值时,Unity 会将此 USS 类添加到Toggle的复选标记。
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 元素 ToolbarSpacer
UXML 元素 TreeView