Class HelpText

A help text.

Inheritance
object
CallbackEventHandler
Focusable
VisualElement
BindableElement
TextElement
BaseTextElement
LocalizedTextElement
HelpText
Implements
INotifyValueChanged<string>
Inherited Members
TextElement.HandleEvent(EventBase)
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 HelpText : LocalizedTextElement, IEventHandler, ITransform, ITransitionAnimations, IExperimentalFeatures, IVisualElementScheduler, IResolvedStyle, IBindable, INotifyValueChanged<string>, IContextOverrideElement, IAdditionalDataHolder

Constructors

HelpText()

Default constructor.

Declaration
public HelpText()

HelpText(string)

Constructor.

Declaration
public HelpText(string text)
Parameters
Type Name Description
string text

The message to display.

Fields

ussClassName

The HelpText main styling class.

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

variantUssClassName

The HelpText variant styling class.

Declaration
public const string variantUssClassName = "appui-help-text--"
Field Value
Type Description
string

Properties

variant

The variant of the HelpText.

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

Methods

GetVariantUssClassName(HelpTextVariant)

Declaration
public static string GetVariantUssClassName(HelpTextVariant enumValue)
Parameters
Type Name Description
HelpTextVariant enumValue
Returns
Type Description
string

Implements

UnityEngine.UIElements.INotifyValueChanged<T>

Extension Methods