版本:Unity 6 (6000.0)
语言:English
UXML 元素 ToolbarMenu
UXML 元素 ToolbarSearchField

UXML 元素 ToolbarPopupSearchField

ToolbarPopupSearchField 是一个仅限编辑器控件,用作带弹出菜单的搜索字段。它是 ToolbarMenuToolbarSearchField 的组合。您可以向下拉菜单添加逻辑以筛选搜索结果。要弹出菜单,用户将鼠标悬停在放大镜图标上。

An example ToolbarPopupSearchField
ToolbarPopupSearchField 示例

创建 ToolbarPopupSearchField

您可以使用UI(用户界面) 允许用户与您的应用程序交互。Unity 目前支持三种 UI 系统。更多信息
参见 术语表
构建器、UXML 或 C# 创建 ToolbarPopupSearchField。以下 C# 示例创建了一个带有菜单、占位符文本和值更改回调的 ToolbarPopupSearchField。

using UnityEditor.UIElements;
...
var toolbarPopupSearchField = new ToolbarPopupSearchField();
toolbarPopupSearchField.value = "Search me";
toolbarPopupSearchField.menu.AppendAction("Action 1", action => Debug.Log("Action 1"));
toolbarPopupSearchField.menu.AppendAction("Action 2", action => Debug.Log("Action 2"));
toolbarPopupSearchField.RegisterValueChangedCallback(evt => Debug.Log("New search value: " + evt.newValue));

C# 基类和命名空间

C# 类ToolbarPopupSearchField
命名空间UnityEditor.UIElements
基类ToolbarSearchField

继承的 UXML 属性

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

名称 类型 描述
focusable 布尔值 如果元素可以聚焦,则为真。
placeholder-text 字符串 一个简短的提示,帮助用户了解在字段中输入什么。
tabindex 整数 用于在焦点环中对可聚焦元素进行排序的整数。必须大于或等于零。

此元素还从 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 选择器 描述
textUssClassName .unity-search-field-base__text-field 此类型元素中文本元素的 USS 类名。
searchButtonUssClassName .unity-search-field-base__search-button 此类型元素中搜索按钮的 USS 类名。
cancelButtonUssClassName .unity-search-field-base__cancel-button 此类型元素中取消按钮的 USS 类名。
cancelButtonOffVariantUssClassName .unity-search-field-base__cancel-button--off 此类型元素中取消按钮的 USS 类名,当它们关闭时。
popupVariantUssClassName .unity-search-field-base--popup 此类型元素的 USS 类名,当它们使用弹出菜单时。
ussClassName .unity-toolbar-search-field 此类型元素的 USS 类名。
ussClassName .unity-search-field-base 此类型元素的 USS 类名。
textUssClassName .unity-search-field-base__text-field 此类型元素中文本元素的 USS 类名。
textInputUssClassName .unity-search-field-base__text-field__input 此类型元素中文本输入元素的 USS 类名。
searchButtonUssClassName .unity-search-field-base__search-button 此类型元素中搜索按钮的 USS 类名。
cancelButtonUssClassName .unity-search-field-base__cancel-button 此类型元素中取消按钮的 USS 类名。
cancelButtonOffVariantUssClassName .unity-search-field-base__cancel-button--off 此类型元素中取消按钮的 USS 类名,当它们关闭时。
popupVariantUssClassName .unity-search-field-base--popup 此类型元素的 USS 类名,当它们使用弹出菜单时。
disabledUssClassName .unity-disabled 本地禁用元素的 USS 类名。

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

其他资源

UXML 元素 ToolbarMenu
UXML 元素 ToolbarSearchField