Legacy Documentation: Version 5.6 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

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

TreeView.CanStartDrag

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

protected function CanStartDrag(args: IMGUI.Controls.TreeView.CanStartDragArgs): bool;
protected bool CanStartDrag(IMGUI.Controls.TreeView.CanStartDragArgs args);

Description

This function is called whenever a TreeViewItem is clicked and dragged. It returns false by default.

Override this function so it returns true to enable drag and drop behavior for TreeViewItems.

You control TreeView drag and drop in the following order:
1) override CanStartDrag to enable dragging TreeViewItems.
2) override SetupDragAndDrop to set which TreeViewItems are dragged.
3) override HandleDragAndDrop to control the drag and drop behavior of the TreeView.