Version: 2022.3
LanguageEnglish
  • C#

TransitionCancelEvent

class in UnityEngine.UIElements

/

Inherits from:UIElements.TransitionEventBase_1

/

Implemented in:UnityEngine.UIElementsModule

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

Description

Event sent when a transition is canceled.

Inherited Members

Properties

bubbles Returns whether this event type bubbles up in the event propagation path.
currentTarget The current target of the event. This is the VisualElement, in the propagation path, for which event handlers are currently being executed.
dispatch Indicates whether the event is being dispatched to a visual element. An event cannot be redispatched while it being dispatched. If you need to recursively dispatch an event, it is recommended that you use a copy of the event.
eventTypeId Retrieves the type ID for this event instance.
imguiEvent The IMGUIEvent at the source of this event. The source can be null since not all events are generated by IMGUI.
isDefaultPrevented Returns true if the default actions should not be executed for this event.
isImmediatePropagationStopped Indicates whether StopImmediatePropagation() was called for this event.
isPropagationStopped Whether StopPropagation() was called for this event.
originalMousePosition The original mouse position of the IMGUI event, before it is transformed to the current target local coordinates.
pooled Whether the event is allocated from a pool of events.
propagationPhase The current propagation phase for this event.
target The target visual element that received this event. Unlike currentTarget, this target does not change when the event is sent to other elements along the propagation path.
timestamp The time when the event was created, in milliseconds.
tricklesDown Returns whether this event is sent down the event propagation path during the TrickleDown phase.
eventTypeId Retrieves the type ID for this event instance.
elapsedTime The number of seconds the transition has been running, excluding delay phase time.
stylePropertyNames The names of the properties associated with the transition.

Public Methods

Dispose Implementation of IDisposable.
PreventDefault Indicates whether the default actions are prevented from being executed for this event.
StopImmediatePropagation Immediately stops the propagation of the event. The event isn't sent to other elements along the propagation path. This method prevents other event handlers from executing on the current target.
StopPropagation Stops propagating this event. The event is not sent to other elements along the propagation path. This method does not prevent other event handlers from executing on the current target.
Dispose Implementation of IDispose.
AffectsProperty Determines whether the ITransitionEvent affects the specified property.

Protected Methods

Init Resets all event members to their initial values.
PostDispatch Allows subclasses to perform custom logic after the event has been dispatched.
PreDispatch Allows subclasses to perform custom logic before the event is dispatched.
Init Resets all event members to their initial values.

Static Methods

RegisterEventType Registers an event class to the event type system.
GetPooled Gets an event from the event pool. Use this function instead of creating new events. Events obtained using this method need to be released back to the pool. You can use Dispose() to release them.
TypeId Retrieves the type ID for this event instance.
GetPooled Gets an event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained from this method should be released back to the pool using Dispose().