UXML element TextField

A TextField allows users to input text data into an application. It accepts and displays text input. You can set placeholder text to provide hints or instructions to the user on what to enter. You can also add validation functions to ensure that the entered data meets certain requirements.

To align a TextField with other fields in an Inspector window, simply apply the .unity-base-field__aligned USS class to it. For more information, refer to BaseField.

Create a TextField

You can create a TextField with UI Builder, UXML, and C#.

To create a TextField with C#, create a new instance of a TextField object. For example:

TextField myElement = new TextField("Label text");

Customize the input text selection

Input text is selectable by default. You can customize the selection behaviors such as selectAllOnMouseUP and selectAllOnFocus.

In C#, set them through textSelection:

myElement.textSelection.selectAllOnMouseUp = false;
myElement.textSelection.selectAllOnFocus = false;

You can also style the selected text using the --unity-selection-color USS custom property. For example, the following USS sets the color of the selected input text to yellow:

.unity-base-text-field__input {
    --unity-selection-color: yellow;
}

Enable a vertical scrollbar

If you have enabled multiline text on the TextField, you can display a vertical scrollbar for the text input field.

In C#, set the verticalScrollerVisibility property to ScrollerVisibility.Auto or ScrollerVisibility.AlwaysVisible:

// Set the multiline property to true to enable multiple lines of text
textField.multiline = true;

// Set the vertical scrollbar visibility to AlwaysVisible
textField.verticalScrollerVisibility = ScrollerVisibility.AlwaysVisible;

Control the behavior of the input text

You can use events to control the behavior of the input text.

For example, to override the default behaviors for the Enter and Shift + Tab keyboard events in a TextField, register a KeyDownEvent to the TrickleDown phase before they’re handled by the TextElement base class:

myField.RegisterCallback<KeyDownEvent>((evt) => { 

    if (evt.keyCode == KeyCode.Enter || evt.character == '/n')
    {
        // Submit logic
        evt.StopPropagation();
        evt.PreventDefault();
    }

    if (evt.modifiers == EventModifiers.Shift && (evt.keyCode == KeyCode.Tab || evt.character == '/t'))
    {
        // Focus logic
        evt.StopPropagation();
        evt.PreventDefault();
    }

}, TrickleDown.TrickleDown);

C# base class and namespace

C# class: TextField
Namespace: UnityEngine.UIElements
Base class: TextInputBaseField_1

Member UXML attributes

This element has the following member attributes:

Inherited UXML attributes

This element inherits the following attributes from its base class:

This element also inherits the following attributes from VisualElement:

USS classes

The following table lists all the C# public property names and their related USS selector.

USS custom properties

The following table outlines the custom properties that are available exclusively for the TextField element in USS:

其他资源

• Work with text
• UXML element Label
• UXML element DoubleField
• UXML element LongField
• UXML element FloatField
• UXML element IntegerField
• UXML element PropertyField