IVsHierarchyDirectionalDropDataTarget.DragEnterArea Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Informs the hierarchy that dragging has entered a new area.

public:
 int DragEnterArea(Microsoft::VisualStudio::OLE::Interop::IDataObject ^ pDataObject, System::UInt32 grfKeyState, System::UInt32 itemid, System::UInt32 area, [Runtime::InteropServices::Out] System::UInt32 % pdwEffect);

int DragEnterArea(Microsoft::VisualStudio::OLE::Interop::IDataObject const & pDataObject, unsigned int grfKeyState, unsigned int itemid, unsigned int area, [Runtime::InteropServices::Out] unsigned int & pdwEffect);

public int DragEnterArea (Microsoft.VisualStudio.OLE.Interop.IDataObject pDataObject, uint grfKeyState, uint itemid, uint area, out uint pdwEffect);

abstract member DragEnterArea : Microsoft.VisualStudio.OLE.Interop.IDataObject * uint32 * uint32 * uint32 * uint32 -> int

Public Function DragEnterArea (pDataObject As IDataObject, grfKeyState As UInteger, itemid As UInteger, area As UInteger, ByRef pdwEffect As UInteger) As Integer

Parameters

pDataObject

IDataObject

[in] The item being dragged. This data object contains the data being transferred in the drag-and-drop operation. If the drop occurs, then this data object (item) is incorporated into the hierarchy window.

grfKeyState

UInt32

[in] Current state of the keyboard and the mouse modifier keys.

itemid

UInt32

[in] Item identifier of the item currently being dragged. For a list of itemid values, see VSConstants.VSITEMID.

area

UInt32

[in] The new area the item is to enter.

pdwEffect

UInt32

[in, out] On entry, pointer to the value of the pdwEffect parameter of the IVsHierarchy object, identifying all effects that the hierarchy supports. On return, must contain one of the effect flags that indicate the result of the drop operation. For more information, see IVsHierarchyDropDataSource2.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

Valid values for grfKeyState are shown in the following table. These values can be combined using a bitwise OR operator.

Hex	Value	Description
0x0001	MK_LBUTTON	Left mouse button is clicked.
0x0002	MK_RBUTTON	Right mouse button is clicked.
0x0004	MK_SHIFT	SHIFT key is pressed.
0x0008	MK_CONTROL	CONTROL key is pressed.
0x0010	MK_MBUTTON	Middle mouse button is clicked.
0x0020	MK_ALT	ALT key is pressed.

Drop effects are included in the pdwEffect parameter and describe the action associated with a drop operation. The following table shows possible pdwEffect values and their descriptions:

Note

These effects are exclusive and cannot be combined using the bitwise OR operator.

EFFECT name	Value	Description
DROPEFFECT_NONE	0	Drop target (hierarchy window) cannot accept the data. No drop would be allowed.
DROPEFFECT_COPY	1	Dropped item remains in the source and a copy of it is added to the target.
DROPEFFECT_MOVE	2	Dropped item was added to the target. The item is removed from the source and its storage is deleted.
DROPEFFECT_LINK	4	A link to the source item is added to the target. The source item should then be removed from the source but the storage should remain so that the link is not broken. A link is a special case of move.

The values of the pwdEffects parameter are taken from the DragDropEffects enumeration.