UXML element ToolbarSearchField

A ToolbarSearchField is an Editor-only control that serves as a search field. It’s a TextField with predefined styles that matches the Toolbar style.

Create a ToolbarSearchField

You can create a ToolbarSearchField with UI Builder, UXML, or C#. The following C# example creates a ToolbarSearchField a placeholder text and a value changed callback:

using UnityEditor.UIElements;
...
var toolbarSearchField = new ToolbarSearchField();
toolbarSearchField.value = "Search me";
toolbarSearchField.RegisterValueChangedCallback(evt => Debug.Log("New search value: " + evt.newValue));

C# base class and namespace

C# class: ToolbarSearchField
Namespace: UnityEditor.UIElements
Base class: SearchFieldBase_2

Inherited UXML attributes

This element inherits the following attributes from its base class:

名称	类型	描述
`focusable`	`boolean`	True if the element can be focused.
`tabindex`	`int`	An integer used to sort focusables in the focus ring. Must be greater than or equal to zero.

This element also inherits the following attributes from VisualElement:

名称	类型	描述
`content-container`	`string`	Child elements are added to it, usually this is the same as the element itself.
`data-source`	`Object`	Assigns a data source to this VisualElement which overrides any inherited data source. This data source is inherited by all children.
`data-source-path`	`string`	Path from the data source to the value.
`name`	`string`	The name of this VisualElement. Use this property to write USS selectors that target a specific element. The standard practice is to give an element a unique name.
`picking-mode`	`UIElements.PickingMode`	Determines if this element can be pick during mouseEvents or `IPanel.Pick` queries.
`style`	`string`	Reference to the style object of this element. Contains data computed from USS files or inline styles written to this object in C#.
`tooltip`	`string`	Text to display inside an information box after the user hovers the element for a small amount of time. This is only supported in the Editor UI.
`usage-hints`	`UIElements.UsageHints`	A combination of hint values that specify high-level intended usage patterns for the `VisualElement`. This property can only be set when the `VisualElement` is not yet part of a `Panel`. Once part of a `Panel`, this property becomes effectively read-only, and attempts to change it will throw an exception. The specification of proper `UsageHints` drives the system to make better decisions on how to process or accelerate certain operations based on the anticipated usage pattern. Note that those hints do not affect behavioral or visual results, but only affect the overall performance of the panel and the elements within. It’s advised to always consider specifying the proper `UsageHints`, but keep in mind that some `UsageHints` might be internally ignored under certain conditions (e.g. due to hardware limitations on the target platform).
`view-data-key`	`string`	Used for view data persistence, such as tree expanded states, scroll position, or zoom level. This key is used to save and load the view data from the view data store. If you don’t set this key, the persistence is disabled for the associated `VisualElement`. For more information, refer to View data persistence.

USS classes

The following table lists all the C# public property names and their related USS selector.

C# property	USS selector	描述
`textUssClassName`	`.unity-search-field-base__text-field`	USS class name of text elements in elements of this type.
`searchButtonUssClassName`	`.unity-search-field-base__search-button`	USS class name of search buttons in elements of this type.
`cancelButtonUssClassName`	`.unity-search-field-base__cancel-button`	USS class name of cancel buttons in elements of this type.
`cancelButtonOffVariantUssClassName`	`.unity-search-field-base__cancel-button--off`	USS class name of cancel buttons in elements of this type, when they are off.
`popupVariantUssClassName`	`.unity-search-field-base--popup`	USS class name of elements of this type, when they are using a popup menu.
`ussClassName`	`.unity-toolbar-search-field`	USS class name of elements of this type.
`ussClassName`	`.unity-search-field-base`	USS class name of elements of this type.
`textUssClassName`	`.unity-search-field-base__text-field`	USS class name of text elements in elements of this type.
`textInputUssClassName`	`.unity-search-field-base__text-field__input`	USS class name of text input elements in elements of this type.
`searchButtonUssClassName`	`.unity-search-field-base__search-button`	USS class name of search buttons in elements of this type.
`cancelButtonUssClassName`	`.unity-search-field-base__cancel-button`	USS class name of cancel buttons in elements of this type.
`cancelButtonOffVariantUssClassName`	`.unity-search-field-base__cancel-button--off`	USS class name of cancel buttons in elements of this type, when they are off.
`popupVariantUssClassName`	`.unity-search-field-base--popup`	USS class name of elements of this type, when they are using a popup menu.
`disabledUssClassName`	`.unity-disabled`	USS class name of local disabled elements.

You can also use the Matching Selectors section in the Inspector or the UI Toolkit Debugger to see which USS selectors affect the components of the VisualElement at every level of its hierarchy.

其他资源

UXML element ToolbarPopupSearchField

UXML element ToolbarSpacer