Events in UI(User Interface) Allows a user to interact with your application. Unity currently supports three UI systems. More info
See in Glossary Toolkit are similar to HTML events. When an event occurs, UI Toolkit sends it to the target visual elementA node of a visual tree that instantiates or derives from the C# VisualElement
class. You can style the look, define the behaviour, and display it on screen as part of the UI. More info
See in Glossary and all elements within the propagation path in the visual treeAn object graph, made of lightweight nodes, that holds all the elements in a window or panel. It defines every UI you build with the UI Toolkit.
See in Glossary.
The event handling sequence is as follows:
As an event moves along the propagation path, the Event.currentTarget
property updates to the element currently handling the event. Within an event callback function:
Event.currentTarget
is the visual element that the callback registers on.Event.target
is the visual element where the original event occurs.For more information, see Dispatching events.
You can register an event callback to customize the behavior of an individual instance of an existing class, such as reacting to a mouse click on a text label. To register a callback for an event, use the RegisterCallback()
method to register the callback directly on the element.
Each element along the propagation path (except the target) can receive an event twice:
By default, a registered callback executes during the target phase and the bubble-up phase. This default behavior ensures that a parent element reacts after its child element.
However, if you want a parent element to react before its child, register your callback with the TrickleDown.TrickleDown
option like this:
using UnityEngine;
using UnityEngine.UIElements;
...
VisualElement myElement = new VisualElement();
// Register a callback for the trickle-down phase.
myElement.RegisterCallback<PointerDownEvent>(MyCallback, TrickleDown.TrickleDown);
...
This informs the dispatcher to execute the callback at the target phase and the trickle-down phase.
To add a custom behavior to a specific visual element, register an event callback on that element like this:
// Register a callback on a pointer down event
myElement.RegisterCallback<PointerDownEvent>(MyCallback);
The signature for the callback function looks like this:
void MyCallback(PointerDownEvent evt) { /* ... */ }
For an element whose child elements handle the event, to register a callback, use the Q()
method to find the child element and register the callback on it.
The following example registers a callback on a slider’s drag container element to handle the pointer up event for the slider. In this case, you must register the callback on the drag container element instead of the slider itself because the drag container captures the pointer during pointer down events, which makes it the only receiver for the next pointer up event.
var dragContainer = slider.Q("unity-drag-container");
dragContainer.RegisterCallback<PointerUpEvent> ( evt => Debug.Log("PointerUpEvent"));
Note: You can register multiple callbacks for an event. However, you can only register the same callback function on the same event and propagation phase once.
To remove a callback from a VisualElement
, call the myElement.UnregisterCallback()
method.
For information on how to get access to a visual element from a MonoBehaviour, refer to Get started with runtime UI.
You can send custom data along with the callback to an event. To attach custom data, you must extend the call to register the callback.
The following example registers a callback for PointerDownEvent
and sends custom data to the callback function:
// Send user data along to the callback
myElement.RegisterCallback<PointerDownEvent, MyType>(MyCallbackWithData, myData);
The signature for the callback function looks like this:
void MyCallbackWithData(PointerDownEvent evt, MyType data) { /* ... */ }
UI controls use the value
property to hold data for their internal state. For example:
Toggle
holds a Boolean value that changes when the Toggle
is turned on or off.IntegerField
holds an integer that holds the field’s value.To get the value of a control:
Get the value from the control directly: int val = myIntegerField.value;
.
Listen to a ChangeEvent
sent by the control and process the change when it happens. You must register your callback to the event like this:
//RegisterValueChangedCallback is a shortcut for RegisterCallback<ChangeEvent>.
//It constrains the right type of T for any VisualElement that implements an
//INotifyValueChange interface.
myIntegerField.RegisterValueChangedCallback(OnIntegerFieldChange);
The signature for the callback function looks like this:
void OnIntegerFieldChange(ChangeEvent<int> evt) { /* ... */ }
To change the value of a control:
value
variable: myControl.value = myNewValue;
. This triggers a new ChangeEvent
.myControl.SetValueWithoutNotify(myNewValue);
. This doesn’t trigger a new ChangeEvent
.For more information, see Change events
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.