Export (0) Print
Expand All

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

The MouseAction type exposes the following members.

  NameDescription
Protected methodMouseAction()Initializes a new instance of the MouseAction class.
Protected methodMouseAction(Diagram)Initializes a new instance of the MouseAction class.
Top

  NameDescription
Public propertyStatic memberActionCanceledStateGets the canceled state for the mouse action.
Public propertyStatic memberActionCompletedStateGets the completed state for the mouse action.
Public propertyCanBumpScrollGets the mouse action and verifies whether it can cause the diagram to scroll.
Public propertyStatic memberClickedStateGets the clicked state for the mouse action.
Public propertyCurrentDiagramArgsGets the event arguments for the current diagram in which the mouse action occurred.
Public propertyCurrentMouseActionEventGets the current event for the mouse action.
Public propertyCurrentMouseActionStateGets the current state for the mouse action.
Public propertyCurrentPointGets or sets the mouse position for the current mouse action.
Protected propertyDiagramGets the diagram to which the mouse action is assigned.
Public propertyStatic memberDragCanceledStateGets the drag cancellation state for the mouse action.
Public propertyStatic memberDragCompletedStateGets the drag completion state for the mouse action.
Public propertyStatic memberDraggingStateGets the drag state of the mouse action.
Public propertyStatic memberDragPendingStateGets the pending drag state for the mouse action.
Public propertyHasTooltipGets the mouse action and verifies whether it can have a tooltip.
Public propertyStatic memberHoveringStateGets the hovering state for the mouse action.
Public propertyStatic memberInactiveStateGets the inactive state for the mouse action.
Public propertyIsActiveGets the mouse action and verifies whether it is active.
Public propertyMouseDownHitShapeGets shape over which the mouse action occurred.
Public propertyMouseDownPointGets the position of the most recent mouse-down event.
Public propertyPreviousPointGets or sets the position of the previous mouse-down event.
Public propertyResetToolboxOnDragDropWhether 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.
Top

  NameDescription
Public methodActivateActivates the mouse action.
Public methodCanCancelGets the mouse action and verifies whether it can be canceled.
Public methodCancelCancels the mouse action.
Public methodCanCompleteGets the mouse action and verifies whether it can be completed.
Protected methodCaptureMouseGets the mouse action.
Public methodClickPerforms actions for derived classes when the mouse is clicked.
Public methodCompleteCompletes the mouse action.
Public methodContextMenuRequestedSends a request for the shortcut menu.
Public methodDispose()Releases all resources used by the MouseAction.
Protected methodDispose(Boolean)Releases the unmanaged resources used by the MouseAction and optionally releases the managed resources.
Public methodDoPaintFeedbackPaints the feedback for the mouse action.
Public methodDoubleClickPerforms actions for derived classes when a user double-clicks the mouse.
Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeFinalizes the mouse action but does not dispose it. (Overrides Object.Finalize().)
Public methodGetCursorGets the pointer to display for the mouse.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTooltipTextGets the tooltip text for an item on the diagram.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGotFocusAssigns the focus to the mouse action.
Protected methodInvalidateInvalidates the feedback from the mouse action.
Public methodLostFocusRemoves focus from the mouse action.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodMouseDownPerforms actions for derived classes when a user clicks the mouse.
Public methodMouseEnterPerforms actions for derived classes when the mouse points to a shape in the diagram.
Public methodMouseHoverPerforms actions for derived classes when the user points to an area or an element in the diagram.
Public methodMouseLeavePerforms actions for derived classes when the mouse no longer points to the shape in the diagram.
Public methodMouseMovePerforms actions for derived classes when the user moves the mouse over the diagram.
Public methodMouseUpPerforms actions for derived classes when the user releases the mouse button.
Public methodMouseWheelPerforms actions for derived classes when the user rotates the mouse wheel.
Protected methodOnClickedAlerts listeners that the user has clicked the mouse.
Protected methodOnContextMenuRequestedAlerts listeners that the user has requested the shortcut menu.
Protected methodOnDiagramGotFocusAlerts listeners that the diagram has the focus.
Protected methodOnDiagramLostFocusCalled when a LostFocus event has been dispatched to this MouseAction.
Protected methodOnDiagramScrolledAlerts listeners that the user has scrolled the diagram.
Protected methodOnDoubleClickAlerts listeners that the user has double-clicked the mouse.
Protected methodOnDragCanceledAlerts listeners that the drag operation has been canceled.
Protected methodOnDragCompletedAlerts listeners that the drag operation has been completed.
Protected methodOnDraggingBegunAlerts listeners that the drag operation has begun.
Protected methodOnDraggingEndedAlerts listeners that the drag operation has ended.
Protected methodOnDragPendingBegunAlerts listeners that the drag operation is pending.
Protected methodOnDragPendingEndedAlerts listeners that the drag operation is no longer pending.
Protected methodOnHoveringBegunAlerts listeners that the mouse is hovering over the diagram.
Protected methodOnHoveringEndedAlerts listeners that the mouse is no longer hovering over the diagram.
Protected methodOnMouseActionActivatedAlerts listeners that the mouse action has begun.
Protected methodOnMouseActionCanceledAlters listeners that the mouse action has been canceled.
Protected methodOnMouseActionCompletedAlerts listeners that the mouse action has completed.
Protected methodOnMouseActionDeactivatedAlerts listeners that the mouse action has been deactivated.
Protected methodOnMouseDownAlerts listeners that the mouse has been clicked.
Protected methodOnMouseEnterAlerts listeners that the mouse has moved over a shape in the diagram.
Protected methodOnMouseHoverAlerts listeners that the mouse is pointing to an area or an element in the diagram.
Protected methodOnMouseLeaveAlerts listeners that the mouse is no longer over the shape in the diagram.
Protected methodOnMouseMoveAlerts listeners that the mouse has been moved over the diagram.
Protected methodOnMouseUpAlerts listeners that the user has released the mouse button.
Protected methodOnMouseWheelAlerts listeners that the user has rotated the mouse wheel.
Protected methodReleaseMouseAlerts listeners that the user has released the mouse button.
Public methodScrolledAlerts listeners that the user has scrolled the diagram.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public eventMouseActionActivatedOccurs when a mouse action starts.
Public eventMouseActionDeactivatedOccurs when a mouse action ends.
Top

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.
Show:
© 2014 Microsoft