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.

GUI.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(position: Rect, text: string): string;
public static string TextArea(Rect position, string text);
public static def TextArea(position as Rect, text as string) as string
public static function TextArea(position: Rect, text: string, maxLength: int): string;
public static string TextArea(Rect position, string text, int maxLength);
public static def TextArea(position as Rect, text as string, maxLength as int) as string
public static function TextArea(position: Rect, text: string, style: GUIStyle): string;
public static string TextArea(Rect position, string text, GUIStyle style);
public static def TextArea(position as Rect, text as string, style as GUIStyle) as string
public static function TextArea(position: Rect, text: string, maxLength: int, style: GUIStyle): string;
public static string TextArea(Rect position, string text, int maxLength, GUIStyle style);
public static def TextArea(position as Rect, text as string, maxLength as int, style as GUIStyle) as string

Parameters

position Rectangle on the screen to use for the text field.
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.

Returns

string The edited string.

Description

Make a Multi-line text area where the user can edit a string.

	var stringToEdit : String = "Hello World\nI've got 2 lines...";
	function OnGUI () {
		// Make a multiline text area that modifies stringToEdit.
		stringToEdit = GUI.TextArea (Rect (10, 10, 200, 100), stringToEdit, 200);
	}

using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    public string stringToEdit = "Hello World\nI've got 2 lines...";
    void OnGUI() {
        stringToEdit = GUI.TextArea(new Rect(10, 10, 200, 100), 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 = GUI.TextArea(Rect(10, 10, 200, 100), stringToEdit, 200)
Copyright © 2014 Unity Technologies
LearnCommunityAsset StoreBuyDownload