Version: 2021.3
UXML element TextElement
UXML element Toggle

UXML element TextField

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

属性

The following table lists all the supported attributes.

名称 类型 描述
binding-path string Path of the target property to be bound.
content-container string child elements are added to this element, usually this
focusable boolean True if the element can be focused.
is-delayed boolean If set to true, the value property isn’t updated until either the user presses Enter or the text field loses focus.
label string The string representing the label that will appear beside the field.
max-length int Maximum number of characters for the field.
multiline boolean Set this to true to allow multiple lines in the textfield and false if otherwise.
name string The name of this VisualElement.

Use this property to write USS selectors that target a specific element.
The standard practice is to give an element a unique name.
picking-mode string Determines if this element can be pick during mouseEvents or IPanel.Pick queries.
style string Reference to the style object of this element.

Contains data computed from USS files or inline styles written to this object in C#.
tabindex int An integer used to sort focusables in the focus ring. Must be greater than or equal to zero.
text string The value of the input field.
tooltip string Text to display inside an information box after the user hovers the element for a small amount of time.
usage-hints string A combination of hint values that specify high-level intended usage patterns for the VisualElement.
This property can only be set when the VisualElement is not yet part of a Panel. Once part of a Panel, this property becomes effectively read-only, and attempts to change it will throw an exception.
The specification of proper UsageHints drives the system to make better decisions on how to process or accelerate certain operations based on the anticipated usage pattern.
Note that those hints do not affect behavioral or visual results, but only affect the overall performance of the panel and the elements within.
It’s advised to always consider specifying the proper UsageHints, but keep in mind that some UsageHints might be internally ignored under certain conditions (e.g. due to hardware limitations on the target platform).
value string The string currently being exposed by the field.

Note that changing this will not trigger a change event to be sent.
view-data-key string Used for view data persistence (ie. tree expanded states, scroll position, zoom level).

This is the key used to save/load the view data from the view data store. Not setting this key will disable persistence for this VisualElement.

Style the TextField

To see which USS selectors affect the components of the TextField at every level of its hierarchy, use the UI Toolkit Debugger:

  1. In Unity, select Window > UI Toolkit > Debugger.
  2. In the UI Toolkit Debugger window, select Pick Element and then select the visual element that you want to debug.

The UI Toolkit Debugger window displays the following:

  • All child elements of the visual element
  • All the USS selectors for each component of the visual element
  • Detailed information of each USS selector
UXML element TextElement
UXML element Toggle