版本:Unity 6 (6000.0)
语言:English
捕获事件
点击事件

更改事件

当元素的值发生变化时,会发送一个ChangeEvent。这通常发生在控件字段中的值发生变化时。例如,当用户切换复选框时。

ChangeEvent 是一个类型化事件,包含视觉元素视觉树的一个节点,它实例化或派生自 C# VisualElement 类。您可以设置外观样式、定义行为并在屏幕上将其显示为 UI 的一部分。 更多信息
参见 词汇表
的前一个值和新值。

事件在更改将新值分配给视觉元素后触发。您无法取消更改事件以阻止视觉元素上的值更改。

ChangeEvent 的基类是EventBase类。

事件 描述 向下传递 向上冒泡 可取消
ChangeEvent 当元素的值发生变化时发送的通用事件。

唯一属性

previousValue:目标控件的前一个值。

newValue:目标控件的新值。

事件列表

ChangeEvent

ChangeEvent 是一个通知事件,允许您对视觉元素的值更改做出反应。例如,当您切换复选框以静音游戏中的音乐时,游戏应停止所有音乐。

此事件适用于所有实现INotifyValueChanged<T>的控件,其中<T>ChangeEvent的类型。此事件还在内部用于更新通过绑定链接到 UI 的对象中的属性。

即使通过代码设置控件的值,它也会触发。您可以通过在INotifyValueChange<T>接口中调用SetValueWithoutNotify来修改控件上的值而不触发ChangeEvent

您可以通过两种方式注册回调函数以接收ChangeEvent

  1. 在视觉元素上调用RegisterCallback<>()
  2. 在派生自INotifyValueChange<T>的视觉元素上调用RegisterValueChangedCallback()

通过RegisterCallback注册回调适用于所有视觉元素,无论它们是否存储内部值。如果要侦听父元素子控件中发生的任何更改,则应使用此方法。

因为ChangeEvent是一个类型化事件,所以在注册事件时必须指定类型。以下代码演示了注册和接收类型为boolChangeEvent

// Registering the callback
rootVisualElement.RegisterCallback<ChangeEvent<bool>>(OnBoolChangedEvent);
// Event callback
private void OnBoolChangedEvent(ChangeEvent<bool> evt) 
{ 
    // Handling code
}

保存值的元素(例如切换和整数字段)实现了INotifyValueChange<T>接口。可以通过调用RegisterValueChangedCallback直接在这些元素上注册回调。这是一种更方便的注册回调的方法,因为类型已内置。您可以通过调用myElement.UnregisterValueChangedCallback再次取消注册事件处理程序。

var newToggle = new Toggle("Test Toggle");
newToggle.RegisterValueChangedCallback(OnTestToggleChanged);
private void OnTestToggleChanged(ChangeEvent<bool> evt)
{ 
    // Handling code
}

target:发生状态更改的元素。

示例

以下示例演示了ChangeEvent的用法以及如何设置和获取控件值。

要查看示例,请执行以下操作

  1. Assets > Scripts > Editor下,创建一个名为ChangeEventTestWindow的C#脚本。
  2. 将示例代码复制到C#脚本中。
  3. 从编辑器工具栏中,选择Window > UI Toolkit > Change Events Test Window

示例 1:注册回调以接收更改事件

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}");
    }
}

示例 2:通过代码设置控件值

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);
    }
}
捕获事件
点击事件