InputEvent

class in UnityEngine.UIElements

/

Inherits from:UIElements.EventBase_1

/

Implemented in:UnityEngine.UIElementsModule

Description

Sends an event when text from a TextField changes.

Properties

newData The new text.
previousData The text before the change occured.

Constructors

InputEvent Constructor.

Protected Methods

Init Resets the event members to their initial values.

Static Methods

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 using this method need to be released back to the pool. You can use Dispose() to release them.

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.
imguiEvent The IMGUIEvent at the source of this event. The source can be null since not all events are generated by IMGUI.
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.

Public Methods

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. If this method is called during the TrickleDown propagation phase, it will prevent default actions to be processed, such as an element getting focused as a result of a PointerDownEvent.
Dispose Implementation of IDispose.

Protected Methods

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.

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.

Did you find this page useful? Please give it a rating: