Share via

IDragProvider Interface

  • Reference

Definition

Namespace:
Windows.UI.Xaml.Automation.Provider
Edit

Enables a Microsoft UI Automation element to describe itself as an element that can be dragged as part of a drag-and-drop operation. Implement this interface in order to support the capabilities that an automation client requests with a GetPattern call and PatternInterface.Drag.

public interface class IDragProvider
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.Guid(779585193, 32764, 20311, 185, 101, 30, 241, 243, 115, 245, 70)]
struct IDragProvider
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.Guid(779585193, 32764, 20311, 185, 101, 30, 241, 243, 115, 245, 70)]
public interface IDragProvider
Public Interface IDragProvider
Attributes
ContractVersionAttribute GuidAttribute

Windows requirements

Device family
Windows 10 (introduced in 10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v1.0)

Remarks

The Drag control pattern is used to support draggable controls, or controls with draggable items. For more info on what this pattern is for, see Drag Control Pattern.

IDragProvider is implemented by the existing Windows Runtime automation peers for a ListView item (ListViewItemAutomationPeer) or GridView item (GridViewItemAutomationPeer). This supports the Windows Runtime scenario of dragging list items so that they can be reordered. The peer for the host view of the items (ListViewAutomationPeer or GridViewAutomationPeer) support the IDropTargetProvider pattern.

Use DragPatternIdentifiers if you want to reference the IDragProvider pattern properties from control code when you fire automation events or call RaisePropertyChangedEvent.

Properties

DropEffect

Gets a string that indicates what will happen when the item is dropped.
DropEffects

Gets an array of strings that enumerates possible drop effects when this item is dropped.
IsGrabbed

Gets a value indicating whether an item is currently being dragged.

Methods

GetGrabbedItems()

Gets an array of UI Automation elements that are being dragged as part of this drag operation.

Applies to

See also