Version: 2023.2
LanguageEnglish
  • C#

DropdownMenuDescriptor

class in UnityEditor.UIElements

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

Describes the main attributes of a dropdown menu.

using UnityEditor;
using UnityEditor.UIElements;
using UnityEngine;
using UnityEngine.UIElements;

public class ContextMenuWindow : EditorWindow { [MenuItem("My/Context Menu Window")] static void ShowMe() => GetWindow<ContextMenuWindow>(); void CreateGUI() { var contextMenuContainer = new VisualElement(); contextMenuContainer.style.flexGrow = 1; contextMenuContainer.AddManipulator(new ContextualMenuManipulator(e => { e.menu.SetDescriptor(new DropdownMenuDescriptor() { allowSubmenus = true, autoClose = true, expansion = true, parseShortcuts = true, title = "My Menu", search = DropdownMenuSearch.Always }); e.menu.AppendAction("Action 1", a => Debug.Log("Action 1 Works"), DropdownMenuAction.AlwaysEnabled); e.menu.AppendSeparator(); e.menu.AppendAction("Submenu/Action 2 _%F1", a => Debug.Log("Action 2 Works"), DropdownMenuAction.AlwaysEnabled); })); rootVisualElement.Add(contextMenuContainer); } }

Properties

allowSubmenusAllows the creation of submenu items.
autoCloseWhether to automatically close a contextual menu when an item action executes.
expansionDisplays a submenu in a new contextual menu next to the parent item.
parseShortcutsParses menu shortcuts at the end of the item name and displays them as keyboard shortcuts next to item names.
searchDisplays a search field at the top of the menu.
titleDescribes the title of the menu.

Constructors

DropdownMenuDescriptorDefines the main attributes of a dropdown menu.