class in UnityEngine.UIElements
/
Inherits from:UIElements.DragAndDropEventBase_1
/
Implemented in:UnityEngine.UIElementsModule
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.
CloseFor 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.
CloseThe event sent to a dragged element when the drag and drop process ends.
DragExitedEvent | Constructor. |
Init | Resets the event members to their initial values. |
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. |
bubbles | Returns whether this event type bubbles up in the event propagation path. |
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. |
actionKey | Returns true if the platform-specific action key is pressed. This key is Cmd on macOS, and Ctrl on all other platforms. |
altKey | Returns true if the Alt key is pressed. |
button | A value that indicates which mouse button was pressed or released (if any) to cause this event: 0 is the left button, 1 is the right button, 2 is the middle button. A negative value indicates that no mouse button changed state during this event. |
clickCount | The number of times the button is pressed. |
commandKey | Returns true if the Windows/Cmd key is pressed. |
ctrlKey | Returns true if the Ctrl key is pressed. |
currentTarget | The current target of the event. The current target is the element in the propagation path for which event handlers are currently being executed. |
localMousePosition | The mouse position in the current target coordinate system. |
modifiers | Flags that hold pressed modifier keys (Alt, Ctrl, Shift, Windows/Cmd). |
mouseDelta | The difference of the mouse position between the previous mouse event and the current mouse event. |
mousePosition | The mouse position in the screen coordinate system. |
pressedButtons | A bitmask that describes the currently pressed buttons. |
shiftKey | Returns true if the Shift key is pressed. |
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. |
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. |
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:
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.