When the value of an element changes, a ChangeEvent
is sent. This is typically sent when a value in a field of a control changes. For example, when the user toggles a checkbox.
The ChangeEvent
is a typed event, and contains both the previous and the new value of the 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.
The event triggers after a change assigns a new value to a visual element. You can’t cancel change events to prevent a value change on a visual element.
The base class for ChangeEvent
is the EventBase class.
Event | Description | Trickles down | Bubbles up | Cancellable |
---|---|---|---|---|
ChangeEvent | A generic event sent when the value of an element changes. | ✔ | ✔ |
previousValue
: The previous value of the target control.
newValue
: The new value of the target control.
ChangeEvent
is a notification event that allows you to react to the value change of a visual element. For example, when you toggle a checkbox to mute music in a game, the game should stop all music.
This event applies to all controls that implement the INotifyValueChanged<T>
, where <T>
is the type of the ChangeEvent
. This event is also used internally to update properties within objects linked to the UI via Bindings.
It fires even when the value of a control is set by code. You can modify the value on a control without firing the ChangeEvent
by calling SetValueWithoutNotify
in the INotifyValueChange<T>
interface.
You can register a callback function to receive a ChangeEvent
in two ways:
RegisterCallback<>()
on a visual elementRegisterValueChangedCallback()
on a visual element deriving from INotifyValueChange<T>
Registering a callback via RegisterCallback works on all visual elements, regardless of whether they store internal values or not. If you want to listen to any changes that happen in the child controls of a parent element, this is the method to use.
Because ChangeEvent
is a typed event, you must specify the type when registering the event. The code below demonstrates registering and receiving a ChangeEvent
of the type bool
.
// Registering the callback rootVisualElement.RegisterCallback<ChangeEvent<bool>>(OnBoolChangedEvent);
// Event callback private void OnBoolChangedEvent(ChangeEvent<bool> evt) { // Handling code }
Elements that hold values, such as toggles and integer fields, implement the INotifyValueChange<T>
interface. It’s possible to register a callback on these elements directly, by calling RegisterValueChangedCallback. This is a more convenient way to register a callback because the type is already built-in. You can unregister event handlers again by calling myElement.UnregisterValueChangedCallback
.
var newToggle = new Toggle("Test Toggle"); newToggle.RegisterValueChangedCallback(OnTestToggleChanged);
private void OnTestToggleChanged(ChangeEvent<bool> evt) { // Handling code }
target
: The element where the change of state occurs.
The following examples demonstrate the usage of ChangeEvent
and how to set and get a control value.
To view an example, do the following:
using UnityEditor; using UnityEngine; using UnityEngine.UIElements; public class ChangeEventTestWindow : EditorWindow { private Toggle m_MyToggle; [MenuItem("Window/UI Toolkit/Change Event Test Window")] public static void ShowExample() { ChangeEventTestWindow wnd = GetWindow<ChangeEventTestWindow>(); wnd.titleContent = new GUIContent("Change Event Test Window"); } public void CreateGUI() { // Create a toggle m_MyToggle = new Toggle("Test Toggle") { name = "My Toggle" }; rootVisualElement.Add(m_MyToggle); // Register a callback on the toggle m_MyToggle.RegisterValueChangedCallback(OnTestToggleChanged); // Register a callback on the parent rootVisualElement.RegisterCallback<ChangeEvent<bool>>(OnBoolChangedEvent); } private void OnBoolChangedEvent(ChangeEvent<bool> evt) { Debug.Log($"Toggle changed. Old value: {evt.previousValue}, new value: {evt.newValue}"); } private void OnTestToggleChanged(ChangeEvent<bool> evt) { Debug.Log($"A bool value changed. Old value: {evt.previousValue}, new value: {evt.newValue}"); } }
using UnityEditor; using UnityEngine; using UnityEngine.UIElements; public class ChangeEventTestWindow : EditorWindow { private Toggle m_MyToggle; [MenuItem("Window/UI Toolkit/Change Event Test Window")] public static void ShowExample() { GetWindow<ChangeEventTestWindow>().titleContent = new GUIContent("Change Event Test Window"); } public void CreateGUI() { // Create a toggle and register callback m_MyToggle = new Toggle("Test Toggle") { name = "My Toggle" }; m_MyToggle.RegisterValueChangedCallback((evt) => { Debug.Log("Change Event received"); }); rootVisualElement.Add(m_MyToggle); // Create button to toggle the toggle's value Button button01 = new Button() { text = "Toggle" }; button01.clicked += () => { m_MyToggle.value = !m_MyToggle.value; }; rootVisualElement.Add(button01); // Create button to toggle the toggle's value without triggering a ChangeEvent Button button02 = new Button() { text = "Toggle without notification" }; button02.clicked += () => { m_MyToggle.SetValueWithoutNotify(!m_MyToggle.value); }; rootVisualElement.Add(button02); } }
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.