Class InputLabel
InputLabel UI element.
Implements
Inherited Members
VisualElement.ExecuteDefaultAction(EventBase)
VisualElement.Focus()
VisualElement.Overlaps(Rect)
VisualElement.ToString()
VisualElement.GetFirstOfType<T>()
VisualElement.GetFirstAncestorOfType<T>()
VisualElement.canGrabFocus
VisualElement.focusController
VisualElement.cacheAsBitmap
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)
Namespace: Unity.AppUI.UI
Assembly: Unity.AppUI.dll
Syntax
public class InputLabel : BaseVisualElement, IEventHandler, IVisualElementScheduler, IExperimentalFeatures, ITransitionAnimations, ITransform, IResolvedStyle, IContextOverrideElement, IAdditionalDataHolderConstructors
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 |
|---|---|
| Visual |
Overrides
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 Help
Declaration
public HelpTextVariant helpVariant { get; set; }Property Value
| Type | Description |
|---|---|
| Help |
indicatorType
The requirement indicator to display.
Declaration
public IndicatorType indicatorType { get; set; }Property Value
| Type | Description |
|---|---|
| Indicator |
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 |
|---|---|
| Text |
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 |