docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class TextField

    Text Field UI element.

    Inheritance
    object
    CallbackEventHandler
    Focusable
    VisualElement
    BaseVisualElement
    ExVisualElement
    TextField
    SearchBar
    Implements
    IEventHandler
    ITransform
    ITransitionAnimations
    IExperimentalFeatures
    IVisualElementScheduler
    IResolvedStyle
    IContextOverrideElement
    IInputElement<string>
    IValidatableElement<string>
    INotifyValueChanging<string>
    INotifyValueChanged<string>
    Inherited Members
    ExVisualElement.outlineColor
    ExVisualElement.backgroundColor
    ExVisualElement.passMask
    BaseVisualElement.contextPrefix
    BaseVisualElement.scaleOverride
    BaseVisualElement.themeOverride
    BaseVisualElement.langOverride
    BaseVisualElement.layoutDirectionOverride
    BaseVisualElement.preferredTooltipPlacementOverride
    BaseVisualElement.tooltipDelayMsOverride
    BaseVisualElement.GetLayoutDirectionUssClassName(Dir)
    VisualElement.disabledUssClassName
    VisualElement.ExecuteDefaultAction(EventBase)
    VisualElement.Focus()
    VisualElement.SendEvent(EventBase)
    VisualElement.SetEnabledFromHierarchy(bool)
    VisualElement.SetEnabled(bool)
    VisualElement.MarkDirtyRepaint()
    VisualElement.ContainsPoint(Vector2)
    VisualElement.Overlaps(Rect)
    VisualElement.DoMeasure(float, VisualElement.MeasureMode, float, VisualElement.MeasureMode)
    VisualElement.ToString()
    VisualElement.GetClasses()
    VisualElement.ClearClassList()
    VisualElement.AddToClassList(string)
    VisualElement.RemoveFromClassList(string)
    VisualElement.ToggleInClassList(string)
    VisualElement.EnableInClassList(string, bool)
    VisualElement.ClassListContains(string)
    VisualElement.FindAncestorUserData()
    VisualElement.Add(VisualElement)
    VisualElement.Insert(int, VisualElement)
    VisualElement.Remove(VisualElement)
    VisualElement.RemoveAt(int)
    VisualElement.Clear()
    VisualElement.ElementAt(int)
    VisualElement.IndexOf(VisualElement)
    VisualElement.Children()
    VisualElement.Sort(Comparison<VisualElement>)
    VisualElement.BringToFront()
    VisualElement.SendToBack()
    VisualElement.PlaceBehind(VisualElement)
    VisualElement.PlaceInFront(VisualElement)
    VisualElement.RemoveFromHierarchy()
    VisualElement.GetFirstOfType<T>()
    VisualElement.GetFirstAncestorOfType<T>()
    VisualElement.Contains(VisualElement)
    VisualElement.FindCommonAncestor(VisualElement)
    VisualElement.viewDataKey
    VisualElement.userData
    VisualElement.canGrabFocus
    VisualElement.focusController
    VisualElement.usageHints
    VisualElement.transform
    VisualElement.layout
    VisualElement.contentRect
    VisualElement.paddingRect
    VisualElement.worldBound
    VisualElement.localBound
    VisualElement.worldTransform
    VisualElement.pickingMode
    VisualElement.name
    VisualElement.enabledInHierarchy
    VisualElement.enabledSelf
    VisualElement.visible
    VisualElement.generateVisualContent
    VisualElement.experimental
    VisualElement.hierarchy
    VisualElement.cacheAsBitmap
    VisualElement.parent
    VisualElement.panel
    VisualElement.visualTreeAssetSource
    VisualElement.this[int]
    VisualElement.childCount
    VisualElement.schedule
    VisualElement.style
    VisualElement.customStyle
    VisualElement.styleSheets
    VisualElement.tooltip
    VisualElement.resolvedStyle
    Focusable.Blur()
    Focusable.focusable
    Focusable.tabIndex
    Focusable.delegatesFocus
    CallbackEventHandler.RegisterCallback<TEventType>(EventCallback<TEventType>, TrickleDown)
    CallbackEventHandler.RegisterCallback<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, TUserArgsType, TrickleDown)
    CallbackEventHandler.UnregisterCallback<TEventType>(EventCallback<TEventType>, TrickleDown)
    CallbackEventHandler.UnregisterCallback<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, TrickleDown)
    CallbackEventHandler.HandleEvent(EventBase)
    CallbackEventHandler.HasTrickleDownHandlers()
    CallbackEventHandler.HasBubbleUpHandlers()
    CallbackEventHandler.ExecuteDefaultActionAtTarget(EventBase)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: Unity.AppUI.UI
    Assembly: Unity.AppUI.dll
    Syntax
    public class TextField : ExVisualElement, IEventHandler, ITransform, ITransitionAnimations, IExperimentalFeatures, IVisualElementScheduler, IResolvedStyle, IContextOverrideElement, IInputElement<string>, IValidatableElement<string>, INotifyValueChanging<string>, INotifyValueChanged<string>

    Constructors

    TextField()

    Default constructor.

    Declaration
    public TextField()

    TextField(string)

    Construct a TextField with a predefined text value. No event will be triggered when setting the text value during construction.

    Declaration
    public TextField(string value)
    Parameters
    Type Name Description
    string value

    A default text value.

    Fields

    inputContainerUssClassName

    The TextField input container styling class.

    Declaration
    public const string inputContainerUssClassName = "appui-textfield__inputcontainer"
    Field Value
    Type Description
    string

    inputUssClassName

    The TextField input styling class.

    Declaration
    public const string inputUssClassName = "appui-textfield__input"
    Field Value
    Type Description
    string

    leadingContainerUssClassName

    The TextField leading container styling class.

    Declaration
    public const string leadingContainerUssClassName = "appui-textfield__leadingcontainer"
    Field Value
    Type Description
    string

    leadingIconUssClassName

    The TextField leading icon styling class.

    Declaration
    public const string leadingIconUssClassName = "appui-textfield__leadingicon"
    Field Value
    Type Description
    string

    placeholderUssClassName

    The TextField placeholder styling class.

    Declaration
    public const string placeholderUssClassName = "appui-textfield__placeholder"
    Field Value
    Type Description
    string

    sizeUssClassName

    The TextField size styling class.

    Declaration
    public const string sizeUssClassName = "appui-textfield--size-"
    Field Value
    Type Description
    string

    trailingContainerUssClassName

    The TextField trailing container styling class.

    Declaration
    public const string trailingContainerUssClassName = "appui-textfield__trailingcontainer"
    Field Value
    Type Description
    string

    trailingIconUssClassName

    The TextField trailing icon styling class.

    Declaration
    public const string trailingIconUssClassName = "appui-textfield__trailingicon"
    Field Value
    Type Description
    string

    ussClassName

    The TextField main styling class.

    Declaration
    public const string ussClassName = "appui-textfield"
    Field Value
    Type Description
    string

    Properties

    contentContainer

    The content container of the TextField.

    Declaration
    public override VisualElement contentContainer { get; }
    Property Value
    Type Description
    VisualElement
    Overrides
    ExVisualElement.contentContainer

    invalid

    The invalid state of the TextField.

    Declaration
    public bool invalid { get; set; }
    Property Value
    Type Description
    bool

    isPassword

    Whether the TextField is a password field.

    Declaration
    public bool isPassword { get; set; }
    Property Value
    Type Description
    bool

    isReadOnly

    Whether the TextField is read-only.

    Declaration
    public bool isReadOnly { get; set; }
    Property Value
    Type Description
    bool

    leadingElement

    The TextField leading element.

    Declaration
    public VisualElement leadingElement { get; set; }
    Property Value
    Type Description
    VisualElement

    leadingIconName

    The leading icon name.

    Declaration
    public string leadingIconName { get; set; }
    Property Value
    Type Description
    string

    maskChar

    The TextField mask character.

    Declaration
    public char maskChar { get; set; }
    Property Value
    Type Description
    char

    maxLength

    The TextField max length.

    Declaration
    public int maxLength { get; set; }
    Property Value
    Type Description
    int

    placeholder

    The TextField placeholder text.

    Declaration
    public string placeholder { get; set; }
    Property Value
    Type Description
    string

    size

    The TextField size.

    Declaration
    public Size size { get; set; }
    Property Value
    Type Description
    Size

    trailingElement

    The TextField trailing element.

    Declaration
    public VisualElement trailingElement { get; set; }
    Property Value
    Type Description
    VisualElement

    trailingIconName

    The trailing icon name.

    Declaration
    public string trailingIconName { get; set; }
    Property Value
    Type Description
    string

    validateValue

    The validation function for the TextField.

    Declaration
    public Func<string, bool> validateValue { get; set; }
    Property Value
    Type Description
    Func<string, bool>

    value

    The TextField value.

    Declaration
    public string value { get; set; }
    Property Value
    Type Description
    string

    Methods

    GetSizeUssClassName(Size)

    Declaration
    public static string GetSizeUssClassName(Size enumValue)
    Parameters
    Type Name Description
    Size enumValue
    Returns
    Type Description
    string

    SetValueWithoutNotify(string)

    Set the TextField value without notifying the change.

    Declaration
    public void SetValueWithoutNotify(string newValue)
    Parameters
    Type Name Description
    string newValue

    The new value of the TextField.

    Implements

    IEventHandler
    ITransform
    ITransitionAnimations
    IExperimentalFeatures
    IVisualElementScheduler
    IResolvedStyle
    IContextOverrideElement
    IInputElement<TValueType>
    IValidatableElement<TValueType>
    INotifyValueChanging<TValueType>
    INotifyValueChanged<T>

    Extension Methods

    NotifyValueChangingExtensions.RegisterValueChangingCallback<TValueType>(INotifyValueChanging<TValueType>, EventCallback<ChangingEvent<TValueType>>)
    NotifyValueChangingExtensions.UnregisterValueChangingCallback<TValueType>(INotifyValueChanging<TValueType>, EventCallback<ChangingEvent<TValueType>>)
    VisualElementExtensions.FindNavController(VisualElement)
    VisualElementExtensions.GetChildren<T>(VisualElement, bool)
    VisualElementExtensions.GetContextProvider<T>(VisualElement)
    VisualElementExtensions.GetContext<T>(VisualElement)
    VisualElementExtensions.GetPreferredTooltipPlacement(VisualElement)
    VisualElementExtensions.GetSelfContext<T>(VisualElement)
    VisualElementExtensions.GetTooltipTemplate(VisualElement)
    VisualElementExtensions.IsContextProvider<T>(VisualElement)
    VisualElementExtensions.ProvideContext<T>(VisualElement, T)
    VisualElementExtensions.RegisterContextChangedCallback<T>(VisualElement, EventCallback<ContextChangedEvent<T>>)
    VisualElementExtensions.SetPreferredTooltipPlacement(VisualElement, OptionalEnum<PopoverPlacement>)
    VisualElementExtensions.SetTooltipTemplate(VisualElement, VisualElement)
    VisualElementExtensions.UnregisterContextChangedCallback<T>(VisualElement, EventCallback<ContextChangedEvent<T>>)
    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)