Legacy Documentation: Version 5.2
LanguageEnglish
  • C#
  • JS

Script language

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

GUILayout.TextArea

Switch to Manual
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

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 textField 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.<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);
    }
}
Copyright © 2015 Unity Technologies
Learn Community Asset Store Buy Download LegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information