Share via

ShapeField.GetPotentialMouseAction Method

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Modeling.Diagrams
Assembly:
Microsoft.VisualStudio.Modeling.Sdk.Diagrams.15.0.dll
Assembly:
Microsoft.VisualStudio.Modeling.Sdk.Diagrams.dll
Package:
Microsoft.VisualStudio.Modeling.Sdk.Diagrams v17.10.40171

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

By default, this method will return the SelectAction. If the field's CanEditValue returns true and the field is already focused, then the InvokeEditorAction will be returned instead.

public:
 virtual Microsoft::VisualStudio::Modeling::Diagrams::MouseAction ^ GetPotentialMouseAction(System::Windows::Forms::MouseButtons mouseButtons, Microsoft::VisualStudio::Modeling::Diagrams::PointD point, Microsoft::VisualStudio::Modeling::Diagrams::DiagramHitTestInfo ^ hitTestInfo);
public virtual Microsoft.VisualStudio.Modeling.Diagrams.MouseAction GetPotentialMouseAction (System.Windows.Forms.MouseButtons mouseButtons, Microsoft.VisualStudio.Modeling.Diagrams.PointD point, Microsoft.VisualStudio.Modeling.Diagrams.DiagramHitTestInfo hitTestInfo);
abstract member GetPotentialMouseAction : System.Windows.Forms.MouseButtons * Microsoft.VisualStudio.Modeling.Diagrams.PointD * Microsoft.VisualStudio.Modeling.Diagrams.DiagramHitTestInfo -> Microsoft.VisualStudio.Modeling.Diagrams.MouseAction
override this.GetPotentialMouseAction : System.Windows.Forms.MouseButtons * Microsoft.VisualStudio.Modeling.Diagrams.PointD * Microsoft.VisualStudio.Modeling.Diagrams.DiagramHitTestInfo -> Microsoft.VisualStudio.Modeling.Diagrams.MouseAction
Public Overridable Function GetPotentialMouseAction (mouseButtons As MouseButtons, point As PointD, hitTestInfo As DiagramHitTestInfo) As MouseAction

Parameters

mouseButtons
MouseButtons

The MouseButtons depressed.

point
PointD

Mouse position relative to Diagram's top-left in world units.

hitTestInfo
DiagramHitTestInfo

The hit test information that corresponds to the mouse position.

Returns

MouseAction

The mouse action that should be made active on the next MouseDown event.

Applies to