Legacy Documentation: Version 5.2
LanguageEnglish
  • C#
  • JS

Script language

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

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

Switch to Manual
public static function TextArea(position: Rect, text: string, style: GUIStyle = EditorStyles.textField): string;
public static string TextArea(Rect position, string text, GUIStyle style = EditorStyles.textField);
public static function TextArea(position: Rect, text: string, style: GUIStyle = EditorStyles.textField): string;
public static string TextArea(Rect position, string text, GUIStyle style = EditorStyles.textField);

Parameters

position Rectangle on the screen to use for the text field.
text The text to edit.
style Optional GUIStyle.

Returns

string The text entered by the user.

Description

Make a text area.

This works just like GUI.TextArea, but correctly responds to select all, copy, paste etc. in the editor.


Text Area in an Editor Window.

	// Create a window where you can have notes
	// This doesnt preserve the notes between sessions. 
	//
	// check EditorPrefs Get/SetString to save the notes.
		
	class EditorGUITextArea extends EditorWindow {
		
		var note : String = "Notes:\n->";
		
		@MenuItem("Examples/Notes")
		static function Init() {
			var window = GetWindow(EditorGUITextArea);
			window.Show();
		}
		
		function OnGUI() {
			note = EditorGUI.TextArea(Rect(3,3,position.width - 6, position.height - 35), note);
			if(GUI.Button(Rect(0, position.height - 30, position.width, 25), "Close"))
				this.Close();
		}	
	}