Legacy Documentation: Version 2017.2 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

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

Experimental: this API is experimental and might be changed or removed in the future.

TextField

class in UnityEngine.Experimental.UIElements

/

Inherits from:Experimental.UIElements.VisualElement

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

Description

A textfield is a rectangular area where the user can edit a string.

Properties

cursorColorThe color of the cursor.
doubleClickSelectsWordSet this to true to allow double-clicks to select the word under the mouse and false if otherwise.
hasFocusReturns true if the textfield has the focus and false if otherwise.
isPasswordFieldSet this to true to mask the characters and false if otherwise.
maskCharThe character used for masking in a password field.
maxLengthThe maximum number of characters this textfield can hold. If 0, there is no limit.
multilineSet this to true to allow multiple lines in the textfield and false if otherwise.
OnTextChangedAction that is called whenever the text changes in the textfield.
OnTextChangeValidatedAction that is called when the user validates the text in the textfield.
selectionColorThe color of the text selection.
tripleClickSelectsLineSet this to true to allow triple-clicks to select the line under the mouse and false if otherwise.

Constructors

TextFieldCreates a new textfield.

Inherited Members

Properties

styleReference to the style object of this element.

Public Methods

OnStyleResolvedCallback when the styles of an object have changed.

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