Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

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

EditorGUILayout.TextField

static function TextField(text: string, params options: GUILayoutOption[]): string;
static string TextField(string text, params GUILayoutOption[] options);
static def TextField(text as string, *options as GUILayoutOption[]) as string
static function TextField(text: string, style: GUIStyle, params options: GUILayoutOption[]): string;
static string TextField(string text, GUIStyle style, params GUILayoutOption[] options);
static def TextField(text as string, style as GUIStyle, *options as GUILayoutOption[]) as string
static function TextField(label: string, text: string, params options: GUILayoutOption[]): string;
static string TextField(string label, string text, params GUILayoutOption[] options);
static def TextField(label as string, text as string, *options as GUILayoutOption[]) as string
static function TextField(label: string, text: string, style: GUIStyle, params options: GUILayoutOption[]): string;
static string TextField(string label, string text, GUIStyle style, params GUILayoutOption[] options);
static def TextField(label as string, text as string, style as GUIStyle, *options as GUILayoutOption[]) as string
static function TextField(label: GUIContent, text: string, params options: GUILayoutOption[]): string;
static string TextField(GUIContent label, string text, params GUILayoutOption[] options);
static def TextField(label as GUIContent, text as string, *options as GUILayoutOption[]) as string
static function TextField(label: GUIContent, text: string, style: GUIStyle, params options: GUILayoutOption[]): string;
static string TextField(GUIContent label, string text, GUIStyle style, params GUILayoutOption[] options);
static def TextField(label as GUIContent, text as string, style as GUIStyle, *options as GUILayoutOption[]) as string

Parameters

labelOptional label to display in front of the text field.
textThe text to edit.
styleOptional GUIStyle.
optionsAn 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 text entered by the user.

Description

Make a text field.

This works just like GUILayout.TextField, but correctly responds to select all, copy, paste etc. in the editor, and it can have an optional label in front.


Changes the name of the selected GameObject.

	// Automatically change the name of the selected object via a text field
	
	class EditorGUILayoutTextField extends EditorWindow {	
		var objectName : String = "";
		@MenuItem("Examples/GUILayout TextField")
		static function Init() {
			var window = GetWindow(EditorGUILayoutTextField);
			window.Show();
		}
		function OnGUI() {
			GUILayout.Label("Select an object in the hierarchy view");
			if(Selection.activeGameObject)
				Selection.activeGameObject.name = 
					EditorGUILayout.TextField("Object Name: ", Selection.activeGameObject.name);
			this.Repaint();
		}
	}