DragEventArgs DragEventArgs DragEventArgs DragEventArgs Class

Definition

Provides data for drag-and-drop events.

public : sealed class DragEventArgs : RoutedEventArgs, IDragEventArgs, IDragEventArgs2, IDragEventArgs3
struct winrt::Windows::UI::Xaml::DragEventArgs : RoutedEventArgs, IDragEventArgs, IDragEventArgs2, IDragEventArgs3
public sealed class DragEventArgs : RoutedEventArgs, IDragEventArgs, IDragEventArgs2, IDragEventArgs3
Public NotInheritable Class DragEventArgs Inherits RoutedEventArgs Implements IDragEventArgs, IDragEventArgs2, IDragEventArgs3
Inheritance
DragEventArgsDragEventArgsDragEventArgsDragEventArgs
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

DragEventArgs is used as event data for these events:

The Control class has pre-wired event handlers that Control derived types can override to provide class-based handling for the drag-drop events, and these methods also use DragEventArgs as a parameter. These methods are:

The Windows Runtime implementation of drag-drop concepts permits only certain controls and input actions to initiate a drag-drop action. There is no generalized DoDragDrop method that would permit any UI element to initiate a drag-drop action. The main source of a drag-drop action is when you drag the items of a list such as GridView. For a list item drag-drop action, the Data value in event data can potentially be modified from the control-defined default data about the item. This is done by handling the DragItemsStarting event, and working with the DataPackage object that is obtained from the DragItemsStartingEventArgs.Data property in the event data.

Properties

AcceptedOperation AcceptedOperation AcceptedOperation AcceptedOperation

Gets or sets a value that specifies which operations are allowed by the originator of the drag event.

AllowedOperations AllowedOperations AllowedOperations AllowedOperations

Gets the allowed data package operations (none, move, copy, and/or link) for the drag and drop operation.

Data Data Data Data

Gets or sets a data object (DataPackage ) that contains the data associated with the corresponding drag event. This value is not useful in all event cases; specifically, the event must be handled by a valid drop target.

DataView DataView DataView DataView

Gets a read-only copy of the Data object.

DragUIOverride DragUIOverride DragUIOverride DragUIOverride

Gets the visual representation of the data being dragged.

Handled Handled Handled Handled

Gets or sets a value that indicates the present state of the event handling for a routed event as it travels the route.

Modifiers Modifiers Modifiers Modifiers

Gets a flag enumeration indicating the current state of the SHIFT, CTRL, and ALT keys, as well as the state of the mouse buttons.

OriginalSource OriginalSource OriginalSource OriginalSource

Gets a reference to the object that raised the event. This is often a template part of a control rather than an element that was declared in your app UI.

(Inherited from RoutedEventArgs)

Methods

GetDeferral() GetDeferral() GetDeferral() GetDeferral()

Supports asynchronous drag-and-drop operations by creating and returning a DragOperationDeferral object.

GetPosition(UIElement) GetPosition(UIElement) GetPosition(UIElement) GetPosition(UIElement)

Returns a drop point that is relative to a specified UIElement.

See Also