Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

TextArea

Make a Multi-line text area where the user can edit a string.
Read time 3 minutesLast updated 4 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.IMGUIModule

TextArea(Rect, string)

Make a Multi-line text area where the user can edit a string.
public static string TextArea(Rect position, string text)

Parameters

position

Rect
Rectangle on the screen to use for the text field.

text

string
Text to edit. The return value of this function should be assigned back to the string as shown in the example.

Returns

Type

Description

stringThe edited string.

Examples

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);    }}

TextArea(Rect, string, int)

Make a Multi-line text area where the user can edit a string.
public static string TextArea(Rect position, string text, int maxLength)

Parameters

position

Rect
Rectangle on the screen to use for the text field.

text

string
Text to edit. The return value of this function should be assigned back to the string as shown in the example.

maxLength

int
The maximum length of the string. If left out, the user can type for ever and ever.

Returns

Type

Description

stringThe edited string.

Examples

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);    }}

TextArea(Rect, string, GUIStyle)

Make a Multi-line text area where the user can edit a string.
public static string TextArea(Rect position, string text, GUIStyle style)

Parameters

position

Rect
Rectangle on the screen to use for the text field.

text

string
Text to edit. The return value of this function should be assigned back to the string as shown in the example.

style

GUIStyle
The style to use. If left out, the 
textArea
style from the current GUISkin is used.

Returns

Type

Description

stringThe edited string.

Examples

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);    }}

TextArea(Rect, string, int, GUIStyle)

Make a Multi-line text area where the user can edit a string.
public static string TextArea(Rect position, string text, int maxLength, GUIStyle style)

Parameters

position

Rect
Rectangle on the screen to use for the text field.

text

string
Text to edit. The return value of this function should be assigned back to the string as shown in the example.

maxLength

int
The maximum length of the string. If left out, the user can type for ever and ever.

style

GUIStyle
The style to use. If left out, the 
textArea
style from the current GUISkin is used.

Returns

Type

Description

stringThe edited string.

Examples

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);    }}