ShapeField.GetPotentialMouseAction Method

Gets the mouse action to activate when the user next clicks a specific point on the diagram.

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

Syntax

'Declaration
Public Overridable Function GetPotentialMouseAction ( _
    mouseButtons As MouseButtons, _
    point As PointD, _
    hitTestInfo As DiagramHitTestInfo _
) As MouseAction

public virtual MouseAction GetPotentialMouseAction(
    MouseButtons mouseButtons,
    PointD point,
    DiagramHitTestInfo hitTestInfo
)

public:
virtual MouseAction^ GetPotentialMouseAction(
    MouseButtons mouseButtons, 
    PointD point, 
    DiagramHitTestInfo^ hitTestInfo
)

abstract GetPotentialMouseAction : 
        mouseButtons:MouseButtons * 
        point:PointD * 
        hitTestInfo:DiagramHitTestInfo -> MouseAction 
override GetPotentialMouseAction : 
        mouseButtons:MouseButtons * 
        point:PointD * 
        hitTestInfo:DiagramHitTestInfo -> MouseAction 

public function GetPotentialMouseAction(
    mouseButtons : MouseButtons, 
    point : PointD, 
    hitTestInfo : DiagramHitTestInfo
) : MouseAction

Parameters

• mouseButtons
  Type: System.Windows.Forms.MouseButtons
  The mouse buttons that can activate the potential mouse action.

• point
  Type: Microsoft.VisualStudio.Modeling.Diagrams.PointD
  The point on the diagram that can activate the mouse action.

• hitTestInfo
  Type: Microsoft.VisualStudio.Modeling.Diagrams.DiagramHitTestInfo
  The information to gather if the potential mouse action occurs.

Return Value

Type: Microsoft.VisualStudio.Modeling.Diagrams.MouseAction
The mouse action to activate when the user next clicks a specific point on the diagram.

Remarks

By default, the shape field is selected. If the shape field has the focus and can be edited, the in-place editor is invoked.

.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.

See Also

Reference

ShapeField Class

Microsoft.VisualStudio.Modeling.Diagrams Namespace