DiagramDragEventArgs Class

  • Article

Provides data for the DragDrop, DragEnter, or DragOver event.

Inheritance Hierarchy

System.Object
  System.EventArgs
    Microsoft.VisualStudio.Modeling.Diagrams.DiagramEventArgs
      Microsoft.VisualStudio.Modeling.Diagrams.DiagramPointEventArgs
        Microsoft.VisualStudio.Modeling.Diagrams.DiagramDragEventArgs

Namespace:  Microsoft.VisualStudio.Modeling.Diagrams
Assembly:  Microsoft.VisualStudio.Modeling.Sdk.Diagrams.12.0 (in Microsoft.VisualStudio.Modeling.Sdk.Diagrams.12.0.dll)

Syntax

'Declaration
Public Class DiagramDragEventArgs _
    Inherits DiagramPointEventArgs

public class DiagramDragEventArgs : DiagramPointEventArgs

public ref class DiagramDragEventArgs : public DiagramPointEventArgs

type DiagramDragEventArgs =  
    class 
        inherit DiagramPointEventArgs 
    end

public class DiagramDragEventArgs extends DiagramPointEventArgs

The DiagramDragEventArgs type exposes the following members.

Constructors

  Name Description
Protected method DiagramDragEventArgs() Initializes a new instance of the DiagramDragEventArgs class.
Public method DiagramDragEventArgs(DragEventArgs, DiagramClientView) Initializes a new instance of the DiagramDragEventArgs class.
Public method DiagramDragEventArgs(DragEventArgs, Boolean, ElementGroupPrototype, DiagramClientView) Initializes a new instance of the DiagramDragEventArgs class.

Top

Properties

  Name Description
Public property AllowedEffect Gets which drag-and-drop operations are allowed by the originator (or source) of the drag event.
Public property Alt Gets a value indicating whether the Alt key is depressed.
Public property Control Gets a value indicating whether the Control key is depressed.
Public property Data Gets the IDataObject that contains the data associated with this event.
Public property DiagramClientView Gets the DiagramClientView that the DiagramEventArgs originated from. (Inherited from DiagramEventArgs.)
Public property DiagramHitTestInfo Gets the hit-test information corresponding to the mouse position. (Inherited from DiagramPointEventArgs.)
Public property Effect Gets or sets the target drop effect in a drag-and-drop operation.
Public property Handled Gets or sets a value indicating whether this event has been handled. (Inherited from DiagramEventArgs.)
Public property HitDiagramItem Gets the diagram item corresponding to the mouse position. (Inherited from DiagramPointEventArgs.)
Public property IsDropLocationUserSpecified Gets a value indicating whether the drop location was specified by the user, or if it was manufactured.
Public property KeyState Gets the current state of the SHIFT, CTRL, and ALT keys, as well as the state of the mouse buttons. bit 1: the left mouse button bit 2: the right mouse button bit 4: the SHIFT key bit 8: the CONTROL key bit 16: the middle mouse button bit 32: the ALT key
Public property MousePosition Gets the mouse position in world units relative to the Diagram's top-left corner. (Inherited from DiagramPointEventArgs.)
Public property Prototype Gets the element group prototype associated with this drag operation. This exists within the raw data object, but is provided as a separate property so that individual clients do not have to deserialize this themselves.
Public property Shift Gets a value indicating whether the Shift key is depressed.

Top

Methods

  Name Description
Public method ComputeEffect This method returns the single resultant drop effect given the possible effects that the drag/drop target can support. The drag source's allowed effects combined with the key states will be used to determine the resultant effect.
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.VisualStudio.Modeling.Diagrams Namespace