docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class MenuItem

    An item contained inside a Menu element.

    Inheritance
    object
    CallbackEventHandler
    Focusable
    VisualElement
    BaseVisualElement
    MenuItem
    Implements
    IEventHandler
    ITransform
    ITransitionAnimations
    IExperimentalFeatures
    IVisualElementScheduler
    IResolvedStyle
    IContextOverrideElement
    INotifyValueChanged<bool>
    IPressable
    Inherited Members
    BaseVisualElement.contextPrefix
    BaseVisualElement.scaleOverride
    BaseVisualElement.themeOverride
    BaseVisualElement.langOverride
    BaseVisualElement.layoutDirectionOverride
    BaseVisualElement.preferredTooltipPlacementOverride
    BaseVisualElement.tooltipDelayMsOverride
    BaseVisualElement.GetLayoutDirectionUssClassName(Dir)
    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.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 class MenuItem : BaseVisualElement, IEventHandler, ITransform, ITransitionAnimations, IExperimentalFeatures, IVisualElementScheduler, IResolvedStyle, IContextOverrideElement, INotifyValueChanged<bool>, IPressable

    Constructors

    MenuItem()

    Default constructor.

    Declaration
    public MenuItem()

    Fields

    activeUssClassname

    The MenuItem active styling class.

    Declaration
    public const string activeUssClassname = "appui-menuitem--active"
    Field Value
    Type Description
    string

    checkmarkUssClassName

    The MenuItem checkmark styling class.

    Declaration
    public const string checkmarkUssClassName = "appui-menuitem__checkmark"
    Field Value
    Type Description
    string

    iconUssClassName

    The MenuItem icon styling class.

    Declaration
    public const string iconUssClassName = "appui-menuitem__icon"
    Field Value
    Type Description
    string

    labelUssClassName

    The MenuItem label styling class.

    Declaration
    public const string labelUssClassName = "appui-menuitem__label"
    Field Value
    Type Description
    string

    selectableUssClassname

    The MenuItem selectable mode styling class.

    Declaration
    public const string selectableUssClassname = "appui-menuitem--selectable"
    Field Value
    Type Description
    string

    shortcutUssClassName

    The MenuItem shortcut styling class.

    Declaration
    public const string shortcutUssClassName = "appui-menuitem__shortcut"
    Field Value
    Type Description
    string

    subMenuIconUssClassname

    The MenuItem submenu icon styling class.

    Declaration
    public const string subMenuIconUssClassname = "appui-menuitem__submenu-icon"
    Field Value
    Type Description
    string

    subMenuItemUssClassname

    The MenuItem submenu mode styling class.

    Declaration
    public const string subMenuItemUssClassname = "appui-menuitem--submenu"
    Field Value
    Type Description
    string

    ussClassName

    The MenuItem main styling class.

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

    Properties

    active

    Enable or disable the active mode of the item.

    Declaration
    public bool active { get; set; }
    Property Value
    Type Description
    bool

    clickable

    Clickable Manipulator for this MenuItem.

    Declaration
    public Pressable clickable { get; set; }
    Property Value
    Type Description
    Pressable

    contentContainer

    The content container of the MenuItem.

    Declaration
    public override VisualElement contentContainer { get; }
    Property Value
    Type Description
    VisualElement
    Overrides
    VisualElement.contentContainer

    hasSubMenu

    Declaration
    public bool hasSubMenu { get; }
    Property Value
    Type Description
    bool

    icon

    The icon to display next to the label.

    Declaration
    public string icon { get; set; }
    Property Value
    Type Description
    string

    label

    The label text value.

    Declaration
    public string label { get; set; }
    Property Value
    Type Description
    string

    selectable

    Enable or disable the selectable mode of the item.

    A selectable item is an item with a small checkmark as leading UI element.

    Declaration
    public bool selectable { get; set; }
    Property Value
    Type Description
    bool

    shortcut

    The shortcut text value.

    Declaration
    public string shortcut { get; set; }
    Property Value
    Type Description
    string

    subMenu

    Sub Menu linked to this item.

    An item with a submenu mode enabled has a small caret as trailing UI element which defines that a sub menu will appear if you trigger the item's action.

    Declaration
    public Menu subMenu { get; set; }
    Property Value
    Type Description
    Menu

    value

    The selected state of the item. You should set the item as selectable first to see any result.

    Declaration
    public bool value { get; set; }
    Property Value
    Type Description
    bool

    Methods

    SetValueWithoutNotify(bool)

    Set the selected state of this item.

    See value and selectable properties for more info.

    Declaration
    public void SetValueWithoutNotify(bool newValue)
    Parameters
    Type Name Description
    bool newValue

    The new selected state.

    Events

    subMenuOpened

    The event raised when the item's submenu is opened.

    Declaration
    public event Action subMenuOpened
    Event Type
    Type Description
    Action

    Implements

    IEventHandler
    ITransform
    ITransitionAnimations
    IExperimentalFeatures
    IVisualElementScheduler
    IResolvedStyle
    IContextOverrideElement
    INotifyValueChanged<T>
    IPressable

    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)