Version: 2017.2 (switch to 2017.3b)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

GUILayout.TextField

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

public static method TextField(text: string, params options: GUILayoutOption[]): string;
public static string TextField(string text, params GUILayoutOption[] options);
public static method TextField(text: string, maxLength: int, params options: GUILayoutOption[]): string;
public static string TextField(string text, int maxLength, params GUILayoutOption[] options);
public static method TextField(text: string, style: GUIStyle, params options: GUILayoutOption[]): string;
public static string TextField(string text, GUIStyle style, params GUILayoutOption[] options);
public static method TextField(text: string, maxLength: int, style: GUIStyle, params options: GUILayoutOption[]): string;
public static string TextField(string text, int maxLength, GUIStyle style, params GUILayoutOption[] options);

Parameters

text Text to edit. The return value of this function should be assigned back to the string as shown in the example.
maxLength The maximum length of the string. If left out, the user can type for ever and ever.
style The style to use. If left out, the textArea style from the current GUISkin is used.
options An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.
See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight.

Returns

string The edited string.

Description

Make a single-line text field where the user can edit a string.


Text field in the GameView.

    var stringToEdit : String = "Hello World";

function OnGUI () { // Make a text field that modifies stringToEdit. stringToEdit = GUILayout.TextField (stringToEdit, 25); }
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { public string stringToEdit = "Hello World"; void OnGUI() { stringToEdit = GUILayout.TextField(stringToEdit, 25); } }

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