docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class InputLabel

    InputLabel UI element.

    Inheritance
    object
    CallbackEventHandler
    Focusable
    VisualElement
    BaseVisualElement
    InputLabel
    Implements
    IEventHandler
    ITransform
    ITransitionAnimations
    IExperimentalFeatures
    IVisualElementScheduler
    IResolvedStyle
    IContextOverrideElement
    Inherited Members
    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 InputLabel : BaseVisualElement, IEventHandler, ITransform, ITransitionAnimations, IExperimentalFeatures, IVisualElementScheduler, IResolvedStyle, IContextOverrideElement

    Constructors

    InputLabel()

    Default constructor.

    Declaration
    public InputLabel()

    InputLabel(string)

    Constructor.

    Declaration
    public InputLabel(string label)
    Parameters
    Type Name Description
    string label

    The label value.

    Fields

    containerUssClassName

    The InputLabel container styling class.

    Declaration
    public const string containerUssClassName = "appui-inputlabel__container"
    Field Value
    Type Description
    string

    fieldLabelUssClassName

    The InputLabel field-label styling class.

    Declaration
    public const string fieldLabelUssClassName = "appui-inputlabel__field-label"
    Field Value
    Type Description
    string

    helpTextUssClassName

    The InputLabel help text styling class.

    Declaration
    public const string helpTextUssClassName = "appui-inputlabel__help-text"
    Field Value
    Type Description
    string

    inputAlignmentUssClassName

    The InputLabel input alignment styling class.

    Declaration
    public const string inputAlignmentUssClassName = "appui-inputlabel--input-alignment-"
    Field Value
    Type Description
    string

    inputContainerUssClassName

    The InputLabel input container styling class.

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

    labelContainerUssClassName

    The InputLabel label container styling class.

    Declaration
    public const string labelContainerUssClassName = "appui-inputlabel__label-container"
    Field Value
    Type Description
    string

    orientationUssClassName

    The InputLabel direction styling class.

    Declaration
    public const string orientationUssClassName = "appui-inputlabel--"
    Field Value
    Type Description
    string

    sizeUssClassName

    The InputLabel size styling class.

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

    ussClassName

    The InputLabel main styling class.

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

    withHelpTextUssClassName

    The InputLabel with help text styling class.

    Declaration
    public const string withHelpTextUssClassName = "appui-inputlabel--with-help-text"
    Field Value
    Type Description
    string

    Properties

    contentContainer

    The content container.

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

    direction

    The orientation of the label.

    Declaration
    public Direction direction { get; set; }
    Property Value
    Type Description
    Direction

    helpMessage

    The error message to display.

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

    helpVariant

    The variant of the HelpText.

    Declaration
    public HelpTextVariant helpVariant { get; set; }
    Property Value
    Type Description
    HelpTextVariant

    indicatorType

    The requirement indicator to display.

    Declaration
    public IndicatorType indicatorType { get; set; }
    Property Value
    Type Description
    IndicatorType

    inputAlignment

    The alignment of the input.

    Declaration
    public Align inputAlignment { get; set; }
    Property Value
    Type Description
    Align

    label

    The label value.

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

    labelOverflow

    The text overflow mode.

    Declaration
    public TextOverflow labelOverflow { get; set; }
    Property Value
    Type Description
    TextOverflow

    required

    Whether the input is required or not in the form. This will add an asterisk next to the label.

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

    requiredText

    The requirement indicator to display.

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

    Methods

    GetInputAlignmentUssClassName(Align)

    Declaration
    public static string GetInputAlignmentUssClassName(Align enumValue)
    Parameters
    Type Name Description
    Align enumValue
    Returns
    Type Description
    string

    GetOrientationUssClassName(Direction)

    Declaration
    public static string GetOrientationUssClassName(Direction enumValue)
    Parameters
    Type Name Description
    Direction enumValue
    Returns
    Type Description
    string

    Implements

    IEventHandler
    ITransform
    ITransitionAnimations
    IExperimentalFeatures
    IVisualElementScheduler
    IResolvedStyle
    IContextOverrideElement

    Extension Methods

    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)