Version: 2018.2 (switch to 2018.1 or 2017.4)
LanguageEnglish
  • C#

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

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 string TextArea(Rect position, string text);
public static string TextArea(Rect position, string text, int maxLength);
public static string TextArea(Rect position, string text, GUIStyle style);
public static string TextArea(Rect position, string text, int maxLength, GUIStyle style);

Parameters

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

using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { public string stringToEdit = "Hello World\nI've got 2 lines...";

void OnGUI() { // Make a multiline text area that modifies stringToEdit. stringToEdit = GUI.TextArea(new Rect(10, 10, 200, 100), stringToEdit, 200); } }

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