Legacy Documentation: Version 4.6.2
Language: English
  • C#
  • JS
  • Boo

Script language

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

GUILayout.TextArea

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

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public static function TextArea(text: string, params options: GUILayoutOption[]): string;
public static string TextArea(string text, params GUILayoutOption[] options);
public static def TextArea(text as string, *options as GUILayoutOption[]) as string
public static function TextArea(text: string, maxLength: int, params options: GUILayoutOption[]): string;
public static string TextArea(string text, int maxLength, params GUILayoutOption[] options);
public static def TextArea(text as string, maxLength as int, *options as GUILayoutOption[]) as string
public static function TextArea(text: string, style: GUIStyle, params options: GUILayoutOption[]): string;
public static string TextArea(string text, GUIStyle style, params GUILayoutOption[] options);
public static def TextArea(text as string, style as GUIStyle, *options as GUILayoutOption[]) as string
public static function TextArea(text: string, maxLength: int, style: GUIStyle, params options: GUILayoutOption[]): string;
public static string TextArea(string text, int maxLength, GUIStyle style, params GUILayoutOption[] options);
public static def TextArea(text as string, maxLength as int, style as GUIStyle, *options as GUILayoutOption[]) as string

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.
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.

	var stringToEdit : String = "Hello World\nI've got 2 lines...";

function OnGUI () { // Make a multiline text area that modifies stringToEdit. stringToEdit = GUILayout.TextArea (stringToEdit, 200); }
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);
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	public stringToEdit as string = 'Hello World\nI\'ve got 2 lines...'

	def OnGUI() as void:
		stringToEdit = GUILayout.TextArea(stringToEdit, 200)