Share via


IDropTargetProvider Interface

Definition

Enables a Microsoft UI Automation element to describe itself as an element that can receive a drop of a dragged element 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.DropTarget.

public interface class IDropTargetProvider
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.Guid(2049203165, 46168, 20448, 152, 200, 170, 200, 157, 245, 109, 97)]
struct IDropTargetProvider
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.Guid(2049203165, 46168, 20448, 152, 200, 170, 200, 157, 245, 109, 97)]
public interface IDropTargetProvider
Public Interface IDropTargetProvider
Derived
Attributes

Windows requirements

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

Remarks

A drop target reports the action if the user drops the dragged item on the peer's owner as drop target. These action results are called effects. The effects are descriptive strings, not visual effects in a UI and design sense. For more info on what this pattern is for, see DropTarget Control Pattern.

IDropTargetProvider is implemented by the existing Windows Runtime automation peers for a ListView or GridView (ListViewAutomationPeer, GridViewAutomationPeer). This supports the Windows Runtime scenario of dragging list items so that they can be reordered. There are a limited number of Windows Runtime classes that can be a drag source; these sources support the IDragProvider pattern for automation purposes.

Use DropTargetPatternIdentifiers if you want to reference the IDropTargetProvider 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.

Applies to

See also