IDragProvider interface

Applies to Windows and Windows Phone

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.

Syntax


public interface IDragProvider

Attributes

[Version(0x06020000)]
[WebHostHidden()]

Members

The IDragProvider interface has these types of members:

Methods

The IDragProvider interface has these methods. It also inherits methods from the Object class.

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

 

Properties

The IDragProvider interface has these properties.

PropertyAccess typeDescription

DropEffect

Read-onlyGets a string that indicates what will happen when the item is dropped.

DropEffects

Read-onlyGets an array of strings that enumerates possible drop effects when this item is dropped.

IsGrabbed

Read-onlyGets a value indicating whether an item is currently being dragged.

 

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.

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8.1 [Windows Runtime apps only]

Namespace

Windows.UI.Xaml.Automation.Provider
Windows::UI::Xaml::Automation::Provider [C++]

Metadata

Windows.winmd

See also

DragPatternIdentifiers
IDragProvider (COM interface)
Custom automation peers
Drag Control Pattern

 

 

Show:
© 2014 Microsoft