Version: 2017.3 (switch to 2017.4)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

ScrollRect.OnBeginDrag

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

public method OnBeginDrag(eventData: EventSystems.PointerEventData): void;
public void OnBeginDrag(EventSystems.PointerEventData eventData);

Parameters

eventData The values used when the drag is started.

Description

Handling for when the content is being dragged.

The handle is selected when the drag is started.

no example available in JavaScript
// Enable the selection of a ScrollView which can be dragged.
// This script only chooses the ScrollView child of the Canvas.

using UnityEngine; using UnityEngine.EventSystems; using UnityEngine.UI;

public class ExampleScript : MonoBehaviour, IBeginDragHandler { private GameObject m_DraggingIcon;

public void Start() { m_DraggingIcon = new GameObject("icon"); }

public void OnBeginDrag(PointerEventData data) { Debug.Log("OnBeginDrag");

var canvas = FindInParents<Canvas>(gameObject); if (canvas == null) return;

m_DraggingIcon.transform.SetParent(canvas.transform, false); m_DraggingIcon.transform.SetAsLastSibling();

Debug.Log("Dragging started"); }

// locate and return the Canvas static public T FindInParents<T>(GameObject go) where T : Component { if (go == null) return null; var comp = go.GetComponent<T>();

if (comp != null) return comp;

Transform t = go.transform.parent; while (t != null && comp == null) { comp = t.gameObject.GetComponent<T>(); t = t.parent; } return comp; } }

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