The following standard controls are built into UIElements :
Contextual menus can present a set of choices or actions to the user, depending on the context. This context is usually the current selection, but the context can be anything.
This topic demonstrates how to add a contextual menu, explains its callbacks, and shows how to respond to user selection.
To enable contextual menus, attach the ContextualMenuManipulator
manipulator to a visual element. This manipulator will display a contextual menu after either a right button mouse up event, or a menu key up event. The ContextualMenuManipulator
manipulator also adds a callback that responds to a ContextualMenuPopulateEvent
. The following code example shows how to do this:
void InstallManipulator(VisualElement element)
{
ContextualMenuManipulator m = new ContextualMenuManipulator(MyDelegate);
m.target = element;
}
void MyDelegate(ContextualMenuPopulateEvent event)
{
// Modify event.menu
event.menu.AppendAction("Properties", DisplayProperties, DropdownMenu.MenuAction.AlwaysEnabled);
}
void DisplayProperties(DropdownMenu.MenuAction menuItem)
{
// ...
}
The callback given to the ContextualMenuManipulator
constructor will be invoked last to allow children elements to populate the menu.
Internally the manipulator sends a ContextualMenuPopulateEvent
event that is propagated to the target element hierarchy, along the propagation path: from the root of the visual tree to the event target, then back up the visual tree to the root. Along the propagation path, the elements with a callback for the ContextualMenuPopulateEvent
event can add, remove, or modify items in the contextual menu.
When an element receives a ContextualMenuPopulateEvent
, it adds menu items to the contextual menu by calling either DropdownMenu.InsertAction()
or DropdownMenu.AppendAction()
.
Each of these functions take two callbacks as parameters. The first callback is executed when the user selects the item in the menu. The second callback is executed before displaying the menu. The second callback also checks whether the menu item is enabled.
Both callbacks receive a MenuAction
as a parameter. The MenuAction
represents the menu item and has the following other useful properties:
MenuAction.userData
contains a reference to user data that might have been used with AppendAction()
or InsertAction()
.MenuAction.eventInfo
contains information about the event that triggered
the display of the contextual menu. Use MenuAction.eventInfo
in the action that responds to the event. For example, you can use the mouse position to create and place an object based on the selected contextual menu item.Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thanks for helping to make the Unity documentation better!