OnGUI
This function displays a search text field with the given Rect and UI style parameters.
Read time 2 minutesLast updated 10 days ago
Definition
- Type: Method
- Namespace: UnityEditor.IMGUI.Controls
- Assembly: UnityEditor.CoreModule
OnGUI(Rect, string, GUIStyle, GUIStyle, GUIStyle)
This function displays a search text field with the given Rect and UI style parameters.
public string OnGUI(Rect rect, string text, GUIStyle style, GUIStyle cancelButtonStyle, GUIStyle emptyCancelButtonStyle)
Parameters
Rectangle to use for the search field.
Text string to display in the search field.
The text field style.
The cancel button style used when there is text in the search field.
The cancel button style used when there is no text in the search field.
Returns
Type | Description |
|---|---|
| string | The text entered in the SearchField. The original input string is returned instead if the search field text was not changed. |
Remarks
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.
OnGUI(Rect, string)
This function displays the search field with the default UI style in the given Rect.
public string OnGUI(Rect rect, string text)
Parameters
Returns
Type | Description |
|---|---|
| string | The text entered in the search field. The original input string is returned instead if the search field text was not changed. |
OnGUI(string, GUILayoutOption[])
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.
public string OnGUI(string text, params GUILayoutOption[] options)
Parameters
Text string to display in the search field.
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.
Additional Resources: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight.
Returns
Type | Description |
|---|---|
| string | The text entered in the search field. The original input string is returned instead if the search field text was not changed. |