Version: 2019.3
LanguageEnglish
  • C#

SearchField

class in UnityEditor.IMGUI.Controls

/

Implemented in:UnityEditor

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

The SearchField control creates a text field for a user to input text that can be used for searching.

It comes in two UI styles: one for normal usage and one for toolbars.

Properties

autoSetFocusOnFindCommandChanges the keyboard focus to the search field when the user presses ‘Ctrl/Cmd + F’ when set to true. It is true by default.
searchFieldControlIDThis is the controlID used for the text field to obtain keyboard focus.

Public Methods

HasFocusThis function returns true if the search field has keyboard focus.
OnGUIThis function displays the search field with the default UI style and uses the GUILayout class to automatically calculate the position and size of the Rect it is rendered to. Pass an optional list to specify extra layout properties.
OnToolbarGUIThis function displays the search field with the toolbar UI style and uses the GUILayout class to automatically calculate the position and size of the Rect it is rendered to. Pass an optional list to specify extra layout properties.
SetFocusThis function changes keyboard focus to the search field so a user can start typing.

Events

downOrUpArrowKeyPressedThis event is dispatched when the focused search field detects that the down or up key is pressed and can be used to change keyboard focus to another control, such as the TreeView.

Delegates

SearchFieldCallbackThis is a generic callback delegate for SearchField events and does not take any parameters.

Did you find this page useful? Please give it a rating: