Version: 2022.3
LanguageEnglish
  • C#
Method group is Obsolete

CallbackEventHandler.HandleEvent

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Obsolete The virtual method CallbackEventHandler.HandleEvent is deprecated and will be removed in a future release. Please override ExecuteDefaultAction instead.

Declaration

public void HandleEvent(UIElements.EventBase evt);

Parameters

evt The event to handle.

Description

Handles an event according to its propagation phase and current target, by executing the element's default action, default action at target, or callbacks associated with the event.

The EventDispatcher may invoke this method multiple times for the same event: once for each propagation phase and each target along the event's propagation path if it has matching callbacks or, in the case of the leaf target, if it overrides default actions for the event.

Do not use this method to intercept all events whose propagation path include this element. There is no guarantee that it will or will not be invoked for a propagation phase or target along the propagation path if that target has no callbacks for the event and has no default action override that can receive the event.

Use CallbackEventHandler.RegisterCallback&lt;TEventType&gt;(EventCallback&lt;TEventType&gt;, TrickleDown), CallbackEventHandler.ExecuteDefaultAction, or CallbackEventHandler.ExecuteDefaultActionAtTarget for more predictable results.

See Also: CallbackEventHandler.RegisterCallback<TEventType>(EventCallback<TEventType>, TrickleDown), CallbackEventHandler.ExecuteDefaultAction, CallbackEventHandler.ExecuteDefaultActionAtTarget