Command events are sent to allow the Unity Editor to forward top-level menu actions to the Editor UI(User Interface) Allows a user to interact with your application. Unity currently supports three UI systems. More info
See in Glossary, as well as their equivalent keyboard shortcuts.
The following are the available commands:
Copy
Cut
Paste
Delete
DeselectAll
SoftDelete
Duplicate
FrameSelected
FrameSelectedWithLock
SelectAll
Find
FocusProjectWindow
Event | Description | Trickles down | Bubbles up | Cancellable |
---|---|---|---|---|
ValidateCommandEvent | The Editor sends this event when determining whether an element in the panel handles the command. | ✔ | ✔ | ✔ |
ExecuteCommandEvent | The Editor sends this event when an element in the panel executes a command. | ✔ | ✔ | ✔ |
target
: The element with keyboard focus. This value is null
if no element has focus.
commandName
: The command to validate or execute.
The ValidateCommandEvent
event asks an EditorWindow if it can execute a command. For example, the Editor can enable or disable a menu item based on the results from the validation command event.
To verify if the Editor can execute a command:
ValidateCommandEvent
.commandName
property of the event.Event.StopPropogation()
method on the event if the command can be executed.The ExecuteCommandEvent
event asks an Editor Window to execute a command.
Even if this event follows a validation event, it’s best practice to ensure the action is possible first, independently of any previous validation.
To respond to the command:
ExecuteCommandEvent
.commandName
property of the event.Event.StopPropogation()
method on the event before executing the actual logic of the command, so the Editor knows that the comment has been executed.The following example uses command events to support copy and paste in a custom Editor Window. The example displays a list of fruits in a custom Editor window. Users can use keyboard shortcuts to copy and paste any fruits.
using System; using System.Collections.Generic; using System.Linq; using UnityEditor; using UnityEngine; using UnityEngine.UIElements; public class CopyPasteExample : EditorWindow { [MenuItem("Window/UI Toolkit Examples/CopyPasteExample")] public static void Show() { GetWindow<CopyPasteExample>(); } readonly List<string> fruits = new () { "Banana", "Apple", "Lime", "Orange" }; ListView m_ListView; public void CreateGUI() { Func<VisualElement> makeItem = () => new Label(); Action<VisualElement, int> bindItem = (e, i) => (e as Label).text = fruits[i]; m_ListView = new ListView(); m_ListView.makeItem = makeItem; m_ListView.bindItem = bindItem; m_ListView.itemsSource = fruits; m_ListView.selectionType = SelectionType.Single; m_ListView.RegisterCallback<ValidateCommandEvent>(OnValidateCommand); m_ListView.RegisterCallback<ExecuteCommandEvent>(OnExecuteCommand); rootVisualElement.Add(m_ListView); } void OnExecuteCommand(ExecuteCommandEvent evt) { if (evt.commandName == "Copy" && m_ListView.selectedIndices.Count() > 0) { EditorGUIUtility.systemCopyBuffer = fruits[m_ListView.selectedIndex]; evt.StopPropagation(); } else if (evt.commandName == "Paste" && !string.IsNullOrEmpty(EditorGUIUtility.systemCopyBuffer)) { fruits.Add(EditorGUIUtility.systemCopyBuffer); m_ListView.RefreshItems(); evt.StopPropagation(); } } void OnValidateCommand(ValidateCommandEvent evt) { if (evt.commandName == "Copy" && m_ListView.selectedIndices.Count() > 0) { evt.StopPropagation(); } else if (evt.commandName == "Paste" && !string.IsNullOrEmpty(EditorGUIUtility.systemCopyBuffer)) { evt.StopPropagation(); } } }
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?
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:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.