TreeView.DragItemsStarting Event

Definition

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Occurs when a drag operation that involves one of the items in the view is initiated.

This documentation applies to WinUI 2 for UWP (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

C#
public event TypedEventHandler<TreeView,TreeViewDragItemsStartingEventArgs> DragItemsStarting;
XAML
<TreeView DragItemsStarting="eventhandler"/>

Event Type

Remarks

To receive this event, set the CanDragItems property to true.

This event occurs when you start a drag-and-drop operation, including when you perform a reorder operation by drag-and-drop. When you perform custom actions as a result of a drag-and-drop operation, you typically listen to this event and provide more data using the TreeViewDragItemsStartingEventArgs.Data property.

You can inspect the items being dragged by checking the TreeViewDragItemsStartingEventArgs.Items property.

You can cancel the drag operation by setting the TreeViewDragItemsStartingEventArgs.Cancel property to true.

Applies to

Product Versions
WinUI 2 2.0, 2.1, 2.2, 2.3, 2.4, 2.5-prerelease, 2.5, 2.6-prerelease, 2.6, 2.7-prerelease, 2.7, 2.8-prerelease, 2.8

See also