ToggleButtonField.GetPotentialMouseAction Method

Retrieves a mouse action that should be made active on the next MouseDown event if the mouse is over the specified point.

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

Syntax

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

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

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

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

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

Parameters

• mouseButtons
  Type: MouseButtons

  The current mouse button state.

• point
  Type: Microsoft.VisualStudio.Modeling.Diagrams.PointD

  The mouse position relative to the diagram's top-left in world units.

• hitTestInfo
  Type: Microsoft.VisualStudio.Modeling.Diagrams.DiagramHitTestInfo

  Information detailing the results of the hit testing.

Return Value

Type: Microsoft.VisualStudio.Modeling.Diagrams.MouseAction

.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

ToggleButtonField Class

Microsoft.VisualStudio.Modeling.Diagrams Namespace