docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class BaseVisualElement

    Base class for all non textual App UI components.

    Inheritance
    object
    CallbackEventHandler
    Focusable
    VisualElement
    BaseVisualElement
    Accordion
    AccordionItem
    ActionBar
    ActionGroup
    Avatar
    AvatarGroup
    Badge
    BaseDialog
    BottomNavBar
    BottomNavBarItem
    BoundsField
    BoundsIntField
    Breadcrumbs
    Canvas
    CanvasBackground
    Checkbox
    Chip
    ColorSwatch
    ColorToolbar
    ColorWheel
    ContextProvider
    DialogTrigger
    Divider
    Drawer
    DrawerHeader
    DropZone
    DropdownItem
    ExVisualElement
    FieldLabel
    InputLabel
    ListViewItem
    Menu
    MenuItem
    MenuSection
    MenuTrigger
    PageIndicator
    PageView
    PickerItem
    Preloader
    Progress
    Quote
    Radio
    RadioGroup
    RectField
    RectIntField
    SVSquare
    Spacer
    StackView
    SwipeView
    SwipeViewItem
    TabItem
    Tabs
    Toggle
    Toolbar
    Vector2Field
    Vector2IntField
    Vector3Field
    Vector3IntField
    Vector4Field
    Implements
    IEventHandler
    ITransform
    ITransitionAnimations
    IExperimentalFeatures
    IVisualElementScheduler
    IResolvedStyle
    IContextOverrideElement
    Inherited Members
    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.contentContainer
    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 abstract class BaseVisualElement : VisualElement, IEventHandler, ITransform, ITransitionAnimations, IExperimentalFeatures, IVisualElementScheduler, IResolvedStyle, IContextOverrideElement

    Constructors

    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
    Type Description
    Optional<string>

    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
    OptionalEnum<Dir>

    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
    OptionalEnum<PopoverPlacement>

    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
    Type Description
    Optional<string>

    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
    Type Description
    Optional<string>

    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
    Type Description
    Optional<int>

    Methods

    GetLayoutDirectionUssClassName(Dir)

    Declaration
    public static string GetLayoutDirectionUssClassName(Dir enumValue)
    Parameters
    Type Name Description
    Dir 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)