LanguageEnglish
  • C#
  • JS

Script language

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

This version of Unity is unsupported.

GUILayout.TextArea

Leave feedback
public static string TextArea(string text, params GUILayoutOption[] options);
public static string TextArea(string text, int maxLength, params GUILayoutOption[] options);
public static string TextArea(string text, GUIStyle style, params GUILayoutOption[] options);
public static string TextArea(string text, int maxLength, GUIStyle style, params GUILayoutOption[] options);

Parameters

textText to edit. The return value of this function should be assigned back to the string as shown in the example.
maxLengthThe maximum length of the string. If left out, the user can type for ever and ever.
styleThe style to use. If left out, the textField style from the current GUISkin is used.
optionsAn optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.<br> 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 multi-line text field where the user can edit a string.


Text area in the Game View.

using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    public string stringToEdit = "Hello World\nI've got 2 lines...";
    void OnGUI() {
        stringToEdit = GUILayout.TextArea(stringToEdit, 200);
    }
}

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright © 2020 Unity Technologies. Publication Date: 2020-06-05.
TutorialsCommunity AnswersKnowledge BaseForumsAsset StoreLegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information