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

EditorGUILayout.PasswordField

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 PasswordField(string password, params GUILayoutOption[] options);
public static string PasswordField(string password, GUIStyle style, params GUILayoutOption[] options);
public static string PasswordField(string label, string password, params GUILayoutOption[] options);
public static string PasswordField(string label, string password, GUIStyle style, params GUILayoutOption[] options);
public static string PasswordField(GUIContent label, string password, params GUILayoutOption[] options);
public static string PasswordField(GUIContent label, string password, GUIStyle style, params GUILayoutOption[] options);

Parameters

labelOptional label to display in front of the password field.
passwordThe password to edit.
styleOptional GUIStyle.
optionsAn optional list of layout options that specify extra layout 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 password entered by the user.

Description

Make a text field where the user can enter a password.

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


Simple window that visualizes what you have typed in the password field.

// Editor Script that creates a password field and lets you
// visualize what have you typed in a label.

using UnityEditor; using UnityEngine;

public class ExampleClass : EditorWindow { string text = "Some text here";

[MenuItem("Examples/Editor Password field usage")] static void Init() { ExampleClass window = (ExampleClass)GetWindow(typeof(ExampleClass)); window.Show(); }

void OnGUI() { text = EditorGUILayout.PasswordField("Type Something:", text); EditorGUILayout.LabelField("Written Text:", text); } }

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