Class HelpText

A help text.

Inheritance

object

CallbackEventHandler

Focusable

VisualElement

BindableElement

TextElement

BaseTextElement

LocalizedTextElement

HelpText

Implements

IEventHandler

IVisualElementScheduler

IExperimentalFeatures

ITransitionAnimations

ITransform

IResolvedStyle

IBindable

INotifyValueChanged<string>

IContextOverrideElement

Inherited Members

LocalizedTextElement.text

LocalizedTextElement.variables

BaseTextElement.contextPrefix

BaseTextElement.scaleOverride

BaseTextElement.themeOverride

BaseTextElement.langOverride

BaseTextElement.layoutDirectionOverride

BaseTextElement.preferredTooltipPlacementOverride

BaseTextElement.tooltipDelayMsOverride

BaseTextElement.GetLayoutDirectionUssClassName(Dir)

TextElement.HandleEvent(EventBase)

TextElement.MeasureTextSize(string, float, VisualElement.MeasureMode, float, VisualElement.MeasureMode)

TextElement.DoMeasure(float, VisualElement.MeasureMode, float, VisualElement.MeasureMode)

TextElement.enableRichText

TextElement.displayTooltipWhenElided

TextElement.isElided

BindableElement.binding

BindableElement.bindingPath

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.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.style

VisualElement.customStyle

VisualElement.styleSheets

VisualElement.schedule

VisualElement.tooltip

VisualElement.experimental

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.hierarchy

VisualElement.cacheAsBitmap

VisualElement.parent

VisualElement.panel

VisualElement.contentContainer

VisualElement.visualTreeAssetSource

VisualElement.this[int]

VisualElement.childCount

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.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 HelpText : LocalizedTextElement, IEventHandler, IVisualElementScheduler, IExperimentalFeatures, ITransitionAnimations, ITransform, IResolvedStyle, IBindable, INotifyValueChanged<string>, IContextOverrideElement

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

IEventHandler

IVisualElementScheduler

IExperimentalFeatures

ITransitionAnimations

ITransform

IResolvedStyle

IBindable

UnityEngine.UIElements.INotifyValueChanged<T>

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>>)