This document is archived and information here might be outdated.  Recommended version.

IPageLayoutControlEvents.OnOleDrop Event (ArcObjects .NET 10.8 SDK)
ArcObjects Help for .NET developers > ArcObjects Help for .NET developers > ArcObjects namespaces > Controls > ESRI ArcGIS Controls > Interfaces > IP > IPageLayoutControlEvents Interface > IPageLayoutControlEvents.OnOleDrop Event
ArcGIS Developer Help

IPageLayoutControlEvents.OnOleDrop Event

Fires when an OLE drop action occurs on the PageLayoutControl.

[Visual Basic .NET]
Public Event OnOleDrop As OnOleDropEventHandler
public event OnOleDropEventHandler OnOleDrop
  esriControlsDropAction dropAction,
  VARIANT dataObjectHelper,
  System.Int32* effect,
  long button,
  long shift,
  long X,
  long Y
dropAction [in]

dropAction is a parameter of type esriControlsDropAction dataObjectHelper [in]
dataObjectHelper is a parameter of type VARIANT effect [in, out]
effect is a parameter of type long* button [in]
button is a parameter of type long shift [in]
shift is a parameter of type long X [in]
X is a parameter of type long Y [in]
Y is a parameter of type long

Product Availability

Available with ArcGIS Engine.


If the IPageLayoutControl::OleDropEnabled property is set to False the OnOleDrop event will not be triggered, and the esriDragDropNone effect will display when data is dragged over the control.

If the IPageLayoutControl::OleDropEnabled property is set to True the esriControlsDragDropEffect must be set each time the OnOleDrop event is triggered.

Use the esriControlsDropAction constant to determine whether the data is entering or leaving the control, or whether data is being dragged over or dropped onto the PageLayoutControl.


Use the esriDropOver dropAction to display mouse coordinates while data is being dragged over the PageLayoutControl from another application, as the OnMouseMove event will not be triggered.

private void axPageLayoutControl1_OnOleDrop(object sender, ESRI.ArcGIS.PageLayoutControl.IPageLayoutControlEvents_OnOleDropEvent e)
    switch (e.dropAction)
        //Data entering the PageLayoutControl
        case esriControlsDropAction.esriDropEnter:
            //Do something..
        //Data dragged over thePageLayoutControl
        case esriControlsDropAction.esriDropOver:
            label1.Text = "x:" + e.x + "  y:" + e.y;
        //Data leaving thePageLayoutControl
        case esriControlsDropAction.esriDropLeave:
            //Do something...
        //Data dropped onto thePageLayoutControl
        case esriControlsDropAction.esriDropped :
            //Do something...
[Visual Basic .NET]
Private Sub AxPageLayoutControl1_OnOleDrop(ByVal sender As Object, ByVal e As ESRI.ArcGIS.PageLayoutControl.IPageLayoutControlEvents_OnOleDropEvent) Handles AxPageLayoutControl1.OnOleDrop 
    'Data entering the PageLayoutControl
    If e.dropAction = esriControlsDropAction.esriDropEnter Then
        'Do something...
    'Data dragged over thePageLayoutControl
    ElseIf e.dropAction = esriControlsDropAction.esriDropOver Then
         Label1.Text = "x:" & e.x & "  y:" & e.y
    'Data leaving thePageLayoutControl
    ElseIf e.dropAction = esriControlsDropAction.esriDropLeave Then
         'Do something...
    'Data dropped onto thePageLayoutControl
     ElseIf e.dropAction = esriControlsDropAction.esriDropped Then
        'Do something...
     End If
End Sub

See Also

IPageLayoutControlEvents Interface