Class PanelEventHandler
Use this class to handle input and send events to UI Toolkit runtime panels.
Inheritance
PanelEventHandler
Inherited Members
Component.GetComponent<T>()
Component.TryGetComponent<T>(out T)
Component.GetComponentInChildren<T>()
Component.GetComponentsInChildren<T>()
Component.GetComponentInParent<T>()
Component.GetComponentsInParent<T>()
Component.GetComponents<T>()
Object.GetHashCode()
Object.InstantiateAsync<T>(T)
Object.InstantiateAsync<T>(T, Transform)
Object.InstantiateAsync<T>(T, Vector3, Quaternion)
Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)
Object.Instantiate<T>(T)
Object.Instantiate<T>(T, Vector3, Quaternion)
Object.Instantiate<T>(T, Vector3, Quaternion, Transform)
Object.Instantiate<T>(T, Transform)
Object.DestroyObject(Object)
Object.FindObjectsOfType<T>()
Object.FindObjectsByType<T>(FindObjectsSortMode)
Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)
Object.FindObjectOfType<T>()
Object.FindFirstObjectByType<T>()
Object.FindAnyObjectByType<T>()
Object.FindFirstObjectByType<T>(FindObjectsInactive)
Object.FindAnyObjectByType<T>(FindObjectsInactive)
Assembly: UnityEngine.UI.dll
Syntax
[AddComponentMenu("UI Toolkit/Panel Event Handler (UI Toolkit)")]
public class PanelEventHandler : UIBehaviour, IPointerMoveHandler, IPointerUpHandler, IPointerDownHandler, ISubmitHandler, ICancelHandler, IMoveHandler, IScrollHandler, ISelectHandler, IDeselectHandler, IPointerExitHandler, IPointerEnterHandler, IPointerClickHandler, IEventSystemHandler
Properties
panel
The panel that this component relates to. If panel is null, this component will have no effect.
Will be set to null automatically if panel is Disposed from an external source.
Declaration
public IPanel panel { get; set; }
Property Value
Methods
OnCancel(BaseEventData)
Declaration
public void OnCancel(BaseEventData eventData)
Parameters
OnDeselect(BaseEventData)
Called by the EventSystem when a new object is being selected.
Declaration
public void OnDeselect(BaseEventData eventData)
Parameters
OnDisable()
Declaration
protected override void OnDisable()
Overrides
OnEnable()
Declaration
protected override void OnEnable()
Overrides
OnMove(AxisEventData)
Called by a BaseInputModule when a move event occurs.
Declaration
public void OnMove(AxisEventData eventData)
Parameters
OnPointerClick(PointerEventData)
Use this callback to detect clicks.
Declaration
public void OnPointerClick(PointerEventData eventData)
Parameters
OnPointerDown(PointerEventData)
Use this callback to detect pointer down events.
Declaration
public void OnPointerDown(PointerEventData eventData)
Parameters
OnPointerEnter(PointerEventData)
Use this callback to detect pointer enter events
Declaration
public void OnPointerEnter(PointerEventData eventData)
Parameters
OnPointerExit(PointerEventData)
Use this callback to detect pointer exit events
Declaration
public void OnPointerExit(PointerEventData eventData)
Parameters
OnPointerMove(PointerEventData)
Use this callback to detect pointer move events
Declaration
public void OnPointerMove(PointerEventData eventData)
Parameters
OnPointerUp(PointerEventData)
Use this callback to detect pointer up events.
Declaration
public void OnPointerUp(PointerEventData eventData)
Parameters
Use this callback to detect scroll events.
Declaration
public void OnScroll(PointerEventData eventData)
Parameters
OnSelect(BaseEventData)
Declaration
public void OnSelect(BaseEventData eventData)
Parameters
OnSubmit(BaseEventData)
Declaration
public void OnSubmit(BaseEventData eventData)
Parameters
Implements
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.