Class ToolbarSearchField

A search field for the toolbar.

Inheritance
Object
CallbackEventHandler
Focusable
VisualElement
SearchFieldBase<TextField, String>
ToolbarSearchField
ToolbarPopupSearchField
Inherited Members
Namespace: UnityEditor.UIElements
Syntax
public class ToolbarSearchField : SearchFieldBase<TextField, string>, IEventHandler, ITransform, ITransitionAnimations, IExperimentalFeatures, IVisualElementScheduler, IResolvedStyle, INotifyValueChanged<string>

Constructors

ToolbarSearchField()

Constructor.

Declaration
public ToolbarSearchField()

Fields

cancelButtonOffVariantUssClassName

USS class name of cancel buttons in elements of this type, when they are off.

Declaration
public static readonly string cancelButtonOffVariantUssClassName
Field Value
Type Description
String

cancelButtonUssClassName

USS class name of cancel buttons in elements of this type.

Declaration
public static readonly string cancelButtonUssClassName
Field Value
Type Description
String

popupVariantUssClassName

USS class name of elements of this type, when they are using a popup menu.

Declaration
public static readonly string popupVariantUssClassName
Field Value
Type Description
String

searchButtonUssClassName

USS class name of search buttons in elements of this type.

Declaration
public static readonly string searchButtonUssClassName
Field Value
Type Description
String

textUssClassName

USS class name of text elements in elements of this type.

Declaration
public static readonly string textUssClassName
Field Value
Type Description
String

ussClassName

USS class name of elements of this type.

Declaration
public static readonly string ussClassName
Field Value
Type Description
String

Properties

searchButton

The search button.

Declaration
protected Button searchButton { get; }
Property Value
Type Description
Button

value

The object currently being exposed by the field.

Declaration
public string value { get; set; }
Property Value
Type Description
String
Remarks

If the new value is different from the current value, this method notifies registered callbacks with a ChangeEvent<T> of type string.

Methods

ClearTextField()

Removes the text when clearing the field.

Declaration
protected override void ClearTextField()
Overrides
UnityEditor.UIElements.SearchFieldBase<UnityEngine.UIElements.TextField, System.String>.ClearTextField()

FieldIsEmpty(String)

Tells if the string is null or empty.

Declaration
protected override bool FieldIsEmpty(string fieldValue)
Parameters
Type Name Description
String fieldValue
Returns
Type Description
Boolean
Overrides
UnityEditor.UIElements.SearchFieldBase<UnityEngine.UIElements.TextField, System.String>.FieldIsEmpty(System.String)

SetValueWithoutNotify(String)

Sets the value for the toolbar search field without sending a change event.

Declaration
public override void SetValueWithoutNotify(string newValue)
Parameters
Type Name Description
String newValue
Overrides
UnityEditor.UIElements.SearchFieldBase<UnityEngine.UIElements.TextField, System.String>.SetValueWithoutNotify(System.String)

Extension Methods