Class BaseVisualElement
Base class for all non textual App UI components.
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 abstract class BaseVisualElement : VisualElement, IEventHandler, IVisualElementScheduler, IExperimentalFeatures, ITransitionAnimations, ITransform, IResolvedStyle, IContextOverrideElement, IAdditionalDataHolderConstructors
BaseVisualElement()
Default constructor.
Declaration
protected BaseVisualElement()Fields
contextPrefix
The context prefix used as USS selector.
Declaration
public const string contextPrefix = "appui--"Field Value
| Type | Description |
|---|---|
| string |
Properties
langOverride
The language to use in this part of the UI.
Declaration
[Tooltip("The language to use in this part of the UI.")]
public Optional<string> langOverride { get; set; }Property Value
layoutDirectionOverride
The layout direction to use in this part of the UI.
Declaration
[Tooltip("The layout direction to use in this part of the UI.")]
public OptionalEnum<Dir> layoutDirectionOverride { get; set; }Property Value
| Type | Description |
|---|---|
| Optional |
preferredTooltipPlacementOverride
Preferred placement for tooltips.
Declaration
[Tooltip("Preferred placement for tooltips.\nNote that this is only a hint and the tooltip may be placed differently if there is not enough space.")]
public OptionalEnum<PopoverPlacement> preferredTooltipPlacementOverride { get; set; }Property Value
| Type | Description |
|---|---|
| Optional |
scaleOverride
The scale to use in this part of the UI.
Declaration
[Tooltip("The scale to use in this part of the UI.")]
public Optional<string> scaleOverride { get; set; }Property Value
themeOverride
The theme to use in this part of the UI.
Declaration
[Tooltip("The theme to use in this part of the UI.")]
public Optional<string> themeOverride { get; set; }Property Value
tooltipDelayMsOverride
Delay in milliseconds before showing a tooltip.
Declaration
[Tooltip("Delay in milliseconds before showing a tooltip.")]
public Optional<int> tooltipDelayMsOverride { get; set; }Property Value
Methods
GetLayoutDirectionUssClassName(Dir)
Declaration
public static string GetLayoutDirectionUssClassName(Dir enumValue)Parameters
| Type | Name | Description |
|---|---|---|
| Dir | enumValue |
Returns
| Type | Description |
|---|---|
| string |