This documentation is archived and is not being maintained.

MouseAction Class

 

Represents a mouse action.

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


public abstract class MouseAction : IDisposable

NameDescription
System_CAPS_protmethodMouseAction()

Initializes a new instance of the MouseAction class.

System_CAPS_protmethodMouseAction(Diagram)

Initializes a new instance of the MouseAction class.

NameDescription
System_CAPS_pubpropertySystem_CAPS_staticActionCanceledState

Gets the canceled state for the mouse action.

System_CAPS_pubpropertySystem_CAPS_staticActionCompletedState

Gets the completed state for the mouse action.

System_CAPS_pubpropertyCanBumpScroll

Gets the mouse action and verifies whether it can cause the diagram to scroll.

System_CAPS_pubpropertySystem_CAPS_staticClickedState

Gets the clicked state for the mouse action.

System_CAPS_pubpropertyCurrentDiagramArgs

Gets the event arguments for the current diagram in which the mouse action occurred.

System_CAPS_pubpropertyCurrentMouseActionEvent

Gets the current event for the mouse action.

System_CAPS_pubpropertyCurrentMouseActionState

Gets the current state for the mouse action.

System_CAPS_pubpropertyCurrentPoint

Gets or sets the mouse position for the current mouse action.

System_CAPS_protpropertyDiagram

Gets the diagram to which the mouse action is assigned.

System_CAPS_pubpropertySystem_CAPS_staticDragCanceledState

Gets the drag cancellation state for the mouse action.

System_CAPS_pubpropertySystem_CAPS_staticDragCompletedState

Gets the drag completion state for the mouse action.

System_CAPS_pubpropertySystem_CAPS_staticDraggingState

Gets the drag state of the mouse action.

System_CAPS_pubpropertySystem_CAPS_staticDragPendingState

Gets the pending drag state for the mouse action.

System_CAPS_pubpropertyHasTooltip

Gets the mouse action and verifies whether it can have a tooltip.

System_CAPS_pubpropertySystem_CAPS_staticHoveringState

Gets the hovering state for the mouse action.

System_CAPS_pubpropertySystem_CAPS_staticInactiveState

Gets the inactive state for the mouse action.

System_CAPS_pubpropertyIsActive

Gets the mouse action and verifies whether it is active.

System_CAPS_pubpropertyMouseDownHitShape

Gets shape over which the mouse action occurred.

System_CAPS_pubpropertyMouseDownPoint

Gets the position of the most recent mouse-down event.

System_CAPS_pubpropertyPreviousPoint

Gets or sets the position of the previous mouse-down event.

System_CAPS_pubpropertyResetToolboxOnDragDrop

Whether to reset toolbox selection after a drag-drop operation triggered by this mouse action. Base implementation always returns true, which means the toolbox selection will be reset after a drag-drop operation triggered by this mouse action.

NameDescription
System_CAPS_pubmethodActivate(DiagramClientView)

Activates the mouse action.

System_CAPS_pubmethodCanCancel(DiagramClientView)

Gets the mouse action and verifies whether it can be canceled.

System_CAPS_pubmethodCancel(DiagramClientView)

Cancels the mouse action.

System_CAPS_pubmethodCanComplete(DiagramClientView)

Gets the mouse action and verifies whether it can be completed.

System_CAPS_protmethodCaptureMouse(DiagramClientView)

Gets the mouse action.

System_CAPS_pubmethodClick(DiagramPointEventArgs)

Performs actions for derived classes when the mouse is clicked.

System_CAPS_pubmethodComplete(DiagramClientView)

Completes the mouse action.

System_CAPS_pubmethodContextMenuRequested(DiagramMouseEventArgs)

Sends a request for the shortcut menu.

System_CAPS_pubmethodDispose()

Releases all resources used by the MouseAction.

System_CAPS_protmethodDispose(Boolean)

Releases the unmanaged resources used by the MouseAction and optionally releases the managed resources.

System_CAPS_pubmethodDoPaintFeedback(DiagramPaintEventArgs)

Paints the feedback for the mouse action.

System_CAPS_pubmethodDoubleClick(DiagramPointEventArgs)

Performs actions for derived classes when a user double-clicks the mouse.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

Finalizes the mouse action but does not dispose it.(Overrides Object.Finalize().)

System_CAPS_pubmethodGetCursor(Cursor, DiagramClientView, PointD)

Gets the pointer to display for the mouse.

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetTooltipText(DiagramItem)

Gets the tooltip text for an item on the diagram.

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodGotFocus(DiagramEventArgs)

Assigns the focus to the mouse action.

System_CAPS_protmethodInvalidate(DiagramClientView)

Invalidates the feedback from the mouse action.

System_CAPS_pubmethodLostFocus(DiagramEventArgs)

Removes focus from the mouse action.

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodMouseDown(DiagramMouseEventArgs)

Performs actions for derived classes when a user clicks the mouse.

System_CAPS_pubmethodMouseEnter(DiagramPointEventArgs)

Performs actions for derived classes when the mouse points to a shape in the diagram.

System_CAPS_pubmethodMouseHover(DiagramPointEventArgs)

Performs actions for derived classes when the user points to an area or an element in the diagram.

System_CAPS_pubmethodMouseLeave(LeaveShapeEventArgs)

Performs actions for derived classes when the mouse no longer points to the shape in the diagram.

System_CAPS_pubmethodMouseMove(DiagramMouseEventArgs)

Performs actions for derived classes when the user moves the mouse over the diagram.

System_CAPS_pubmethodMouseUp(DiagramMouseEventArgs)

Performs actions for derived classes when the user releases the mouse button.

System_CAPS_pubmethodMouseWheel(DiagramMouseEventArgs)

Performs actions for derived classes when the user rotates the mouse wheel.

System_CAPS_protmethodOnClicked(MouseActionEventArgs)

Alerts listeners that the user has clicked the mouse.

System_CAPS_protmethodOnContextMenuRequested(DiagramMouseEventArgs)

Alerts listeners that the user has requested the shortcut menu.

System_CAPS_protmethodOnDiagramGotFocus(DiagramEventArgs)

Alerts listeners that the diagram has the focus.

System_CAPS_protmethodOnDiagramLostFocus(LostFocusEventArgs)

Called when a LostFocus event has been dispatched to this MouseAction.

System_CAPS_protmethodOnDiagramScrolled(DiagramEventArgs)

Alerts listeners that the user has scrolled the diagram.

System_CAPS_protmethodOnDoubleClick(DiagramPointEventArgs)

Alerts listeners that the user has double-clicked the mouse.

System_CAPS_protmethodOnDragCanceled(MouseActionEventArgs)

Alerts listeners that the drag operation has been canceled.

System_CAPS_protmethodOnDragCompleted(MouseActionEventArgs)

Alerts listeners that the drag operation has been completed.

System_CAPS_protmethodOnDraggingBegun(MouseActionEventArgs)

Alerts listeners that the drag operation has begun.

System_CAPS_protmethodOnDraggingEnded(MouseActionEventArgs)

Alerts listeners that the drag operation has ended.

System_CAPS_protmethodOnDragPendingBegun(MouseActionEventArgs)

Alerts listeners that the drag operation is pending.

System_CAPS_protmethodOnDragPendingEnded(MouseActionEventArgs)

Alerts listeners that the drag operation is no longer pending.

System_CAPS_protmethodOnHoveringBegun(MouseActionEventArgs)

Alerts listeners that the mouse is hovering over the diagram.

System_CAPS_protmethodOnHoveringEnded(MouseActionEventArgs)

Alerts listeners that the mouse is no longer hovering over the diagram.

System_CAPS_protmethodOnMouseActionActivated(DiagramEventArgs)

Alerts listeners that the mouse action has begun.

System_CAPS_protmethodOnMouseActionCanceled(DiagramEventArgs)

Alters listeners that the mouse action has been canceled.

System_CAPS_protmethodOnMouseActionCompleted(DiagramEventArgs)

Alerts listeners that the mouse action has completed.

System_CAPS_protmethodOnMouseActionDeactivated(DiagramEventArgs)

Alerts listeners that the mouse action has been deactivated.

System_CAPS_protmethodOnMouseDown(DiagramMouseEventArgs)

Alerts listeners that the mouse has been clicked.

System_CAPS_protmethodOnMouseEnter(DiagramPointEventArgs)

Alerts listeners that the mouse has moved over a shape in the diagram.

System_CAPS_protmethodOnMouseHover(DiagramPointEventArgs)

Alerts listeners that the mouse is pointing to an area or an element in the diagram.

System_CAPS_protmethodOnMouseLeave(LeaveShapeEventArgs)

Alerts listeners that the mouse is no longer over the shape in the diagram.

System_CAPS_protmethodOnMouseMove(DiagramMouseEventArgs)

Alerts listeners that the mouse has been moved over the diagram.

System_CAPS_protmethodOnMouseUp(DiagramMouseEventArgs)

Alerts listeners that the user has released the mouse button.

System_CAPS_protmethodOnMouseWheel(DiagramMouseEventArgs)

Alerts listeners that the user has rotated the mouse wheel.

System_CAPS_protmethodReleaseMouse(DiagramClientView)

Alerts listeners that the user has released the mouse button.

System_CAPS_pubmethodScrolled(DiagramEventArgs)

Alerts listeners that the user has scrolled the diagram.

System_CAPS_pubmethodToString()

(Inherited from Object.)

NameDescription
System_CAPS_pubeventMouseActionActivated

Occurs when a mouse action starts.

System_CAPS_pubeventMouseActionDeactivated

Occurs when a mouse action ends.

Derive from this class to create your own custom mouse actions, such as a connector mouse tool.

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

Return to top
Show: