IDragProvider::DropEffect property

Retrieves a localized string that indicates what happens when this element is dropped as part of a drag-drop operation.

This property is read-only.

Syntax


HRESULT get_DropEffect(
  [out, retval, optional]  BSTR *pRetVal
);

Property value

Type: BSTR*

A localized string that indicates what happens when this element is dropped. This property is NULL if this element doesn't implement the source-only style of UI Automation drag-and-drop; that is, the drop target defines its own drop effects.

Remarks

In the source-only style of UI Automation drag-and-drop, no elements implement the DropTarget pattern. To find out what effect dropping the dragged element will have, a client can query the DropEffect property of the dragged element. This property can be a short string such as "move", or a longer one, such as "insert into Main group". The string is always localized.

If this property changes, the provider must notify clients by calling UiaRaiseAutomationPropertyChangedEvent and specifying a property identifier of UIA_DragIsGrabbedPropertyId or UIA_DragDropEffectPropertyId.

Requirements

Minimum supported client

Windows 8 [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2012 [desktop apps | Windows Store apps]

Header

UIAutomationCore.h (include UIAutomation.h)

IDL

UIAutomationCore.idl

See also

IDragProvider

 

 

Community Additions

ADD
Show:
© 2014 Microsoft