Documentation

Version:

Version:

SearchField

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

Read time 1 minute

Last updated 13 days ago


public class SearchField

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

Property	Description
autoSetFocusOnFindCommand	Changes the keyboard focus to the search field when the user presses ‘Ctrl/Cmd + F’ when set to true. It is true by default.
searchFieldControlID	This is the controlID used for the text field to obtain keyboard focus.

Method	Description
HasFocus	This function returns true if the search field has keyboard focus.
OnGUI	This 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.
OnToolbarGUI	This 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.
SetFocus	This function changes keyboard focus to the search field so a user can start typing.

Member	Description
downOrUpArrowKeyPressed	This 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.

Delegate	Description
SearchField.SearchFieldCallback	This is a generic callback delegate for SearchField events and does not take any parameters.