Version: 2022.3
LanguageEnglish
  • C#

SearchField.OnGUI

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

Declaration

public string OnGUI(string text, params GUILayoutOption[] options);

Parameters

text Text string to display in the search field.
options An optional list of layout options that specify extra layout properties.
Additional resources: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight.

Returns

string The text entered in the search field. The original input string is returned instead if the search field text was not changed.

Description

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.


Declaration

public string OnGUI(Rect rect, string text);

Parameters

rect Rectangle to use for the search field.
text Text string to display in the search field.

Returns

string The text entered in the search field. The original input string is returned instead if the search field text was not changed.

Description

This function displays the search field with the default UI style in the given Rect.


Declaration

public string OnGUI(Rect rect, string text, GUIStyle style, GUIStyle cancelButtonStyle, GUIStyle emptyCancelButtonStyle);

Parameters

rect Rectangle to use for the search field.
text Text string to display in the search field.
style The text field style.
cancelButtonStyle The cancel button style used when there is text in the search field.
emptyCancelButtonStyle The cancel button style used when there is no text in the search field.

Returns

string The text entered in the SearchField. The original input string is returned instead if the search field text was not changed.

Description

This function displays a search text field with the given Rect and UI style parameters.

Use this function to customize the UI style of the search text field. You must set cancelButtonStyle.fixedWidth to a suitable and desired width as this affects the placement of the close button to the right of the search text field.