IVsHierarchyDirectionalDropDataTarget.DragEnterArea Method
Informs the hierarchy that dragging has entered a new area.
Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop.11.0 (in Microsoft.VisualStudio.Shell.Interop.11.0.dll)
Syntax
'Declaration
Function DragEnterArea ( _
pDataObject As IDataObject, _
grfKeyState As UInteger, _
itemid As UInteger, _
area As UInteger, _
<OutAttribute> ByRef pdwEffect As UInteger _
) As Integer
int DragEnterArea(
IDataObject pDataObject,
uint grfKeyState,
uint itemid,
uint area,
out uint pdwEffect
)
int DragEnterArea(
[InAttribute] IDataObject^ pDataObject,
[InAttribute] unsigned int grfKeyState,
[InAttribute] unsigned int itemid,
[InAttribute] unsigned int area,
[InAttribute] [OutAttribute] unsigned int% pdwEffect
)
abstract DragEnterArea :
pDataObject:IDataObject *
grfKeyState:uint32 *
itemid:uint32 *
area:uint32 *
pdwEffect:uint32 byref -> int
function DragEnterArea(
pDataObject : IDataObject,
grfKeyState : uint,
itemid : uint,
area : uint,
pdwEffect : uint
) : int
Parameters
pDataObject
Type: Microsoft.VisualStudio.OLE.Interop.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
Type: UInt32[in] Current state of the keyboard and the mouse modifier keys.
itemid
Type: UInt32[in] Item identifier of the item currently being dragged. For a list of itemid values, see VSConstants.VSITEMID.
area
Type: UInt32[in] The new area the item is to enter.
pdwEffect
Type: 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.
Return Value
Type: 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.
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.