MouseAction Class
Represents a mouse action.
Inheritance Hierarchy
System.Object
Microsoft.VisualStudio.Modeling.Diagrams.MouseAction
Microsoft.VisualStudio.Modeling.Diagrams.InvokeEditorAction
Microsoft.VisualStudio.Modeling.Diagrams.PanZoomAction
Microsoft.VisualStudio.Modeling.Diagrams.ResizeAction
Microsoft.VisualStudio.Modeling.Diagrams.SelectAction
Namespace: Microsoft.VisualStudio.Modeling.Diagrams
Assembly: Microsoft.VisualStudio.Modeling.Sdk.Diagrams.12.0 (in Microsoft.VisualStudio.Modeling.Sdk.Diagrams.12.0.dll)
Syntax
'Declaration
Public MustInherit Class MouseAction _
Implements IDisposable
public abstract class MouseAction : IDisposable
public ref class MouseAction abstract : IDisposable
[<AbstractClass>]
type MouseAction =
class
interface IDisposable
end
public abstract class MouseAction implements IDisposable
The MouseAction type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Protected method") |
MouseAction() | Initializes a new instance of the MouseAction class. |
|
MouseAction(Diagram) | Initializes a new instance of the MouseAction class. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") .gif "Static member") |
ActionCanceledState | Gets the canceled state for the mouse action. |
|
ActionCompletedState | Gets the completed state for the mouse action. |
|
CanBumpScroll | Gets the mouse action and verifies whether it can cause the diagram to scroll. |
|
ClickedState | Gets the clicked state for the mouse action. |
|
CurrentDiagramArgs | Gets the event arguments for the current diagram in which the mouse action occurred. |
|
CurrentMouseActionEvent | Gets the current event for the mouse action. |
|
CurrentMouseActionState | Gets the current state for the mouse action. |
|
CurrentPoint | Gets or sets the mouse position for the current mouse action. |
.gif "Protected property") |
Diagram | Gets the diagram to which the mouse action is assigned. |
|
DragCanceledState | Gets the drag cancellation state for the mouse action. |
|
DragCompletedState | Gets the drag completion state for the mouse action. |
|
DraggingState | Gets the drag state of the mouse action. |
|
DragPendingState | Gets the pending drag state for the mouse action. |
|
HasTooltip | Gets the mouse action and verifies whether it can have a tooltip. |
|
HoveringState | Gets the hovering state for the mouse action. |
|
InactiveState | Gets the inactive state for the mouse action. |
|
IsActive | Gets the mouse action and verifies whether it is active. |
|
MouseDownHitShape | Gets shape over which the mouse action occurred. |
|
MouseDownPoint | Gets the position of the most recent mouse-down event. |
|
PreviousPoint | Gets or sets the position of the previous mouse-down event. |
|
ResetToolboxOnDragDrop | 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. |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
Activate | Activates the mouse action. |
|
CanCancel | Gets the mouse action and verifies whether it can be canceled. |
|
Cancel | Cancels the mouse action. |
|
CanComplete | Gets the mouse action and verifies whether it can be completed. |
|
CaptureMouse | Gets the mouse action. |
|
Click | Performs actions for derived classes when the mouse is clicked. |
|
Complete | Completes the mouse action. |
|
ContextMenuRequested | Sends a request for the shortcut menu. |
|
Dispose() | Releases all resources used by the MouseAction. |
|
Dispose(Boolean) | Releases the unmanaged resources used by the MouseAction and optionally releases the managed resources. |
|
DoPaintFeedback | Paints the feedback for the mouse action. |
|
DoubleClick | Performs actions for derived classes when a user double-clicks the mouse. |
|
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
|
Finalize | Finalizes the mouse action but does not dispose it. (Overrides Object.Finalize().) |
|
GetCursor | Gets the pointer to display for the mouse. |
|
GetHashCode | Serves as the default hash function. (Inherited from Object.) |
|
GetTooltipText | Gets the tooltip text for an item on the diagram. |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
GotFocus | Assigns the focus to the mouse action. |
|
Invalidate | Invalidates the feedback from the mouse action. |
|
LostFocus | Removes focus from the mouse action. |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
MouseDown | Performs actions for derived classes when a user clicks the mouse. |
|
MouseEnter | Performs actions for derived classes when the mouse points to a shape in the diagram. |
|
MouseHover | Performs actions for derived classes when the user points to an area or an element in the diagram. |
|
MouseLeave | Performs actions for derived classes when the mouse no longer points to the shape in the diagram. |
|
MouseMove | Performs actions for derived classes when the user moves the mouse over the diagram. |
|
MouseUp | Performs actions for derived classes when the user releases the mouse button. |
|
MouseWheel | Performs actions for derived classes when the user rotates the mouse wheel. |
|
OnClicked | Alerts listeners that the user has clicked the mouse. |
|
OnContextMenuRequested | Alerts listeners that the user has requested the shortcut menu. |
|
OnDiagramGotFocus | Alerts listeners that the diagram has the focus. |
|
OnDiagramLostFocus | Called when a LostFocus event has been dispatched to this MouseAction. |
|
OnDiagramScrolled | Alerts listeners that the user has scrolled the diagram. |
|
OnDoubleClick | Alerts listeners that the user has double-clicked the mouse. |
|
OnDragCanceled | Alerts listeners that the drag operation has been canceled. |
|
OnDragCompleted | Alerts listeners that the drag operation has been completed. |
|
OnDraggingBegun | Alerts listeners that the drag operation has begun. |
|
OnDraggingEnded | Alerts listeners that the drag operation has ended. |
|
OnDragPendingBegun | Alerts listeners that the drag operation is pending. |
|
OnDragPendingEnded | Alerts listeners that the drag operation is no longer pending. |
|
OnHoveringBegun | Alerts listeners that the mouse is hovering over the diagram. |
|
OnHoveringEnded | Alerts listeners that the mouse is no longer hovering over the diagram. |
|
OnMouseActionActivated | Alerts listeners that the mouse action has begun. |
|
OnMouseActionCanceled | Alters listeners that the mouse action has been canceled. |
|
OnMouseActionCompleted | Alerts listeners that the mouse action has completed. |
|
OnMouseActionDeactivated | Alerts listeners that the mouse action has been deactivated. |
|
OnMouseDown | Alerts listeners that the mouse has been clicked. |
|
OnMouseEnter | Alerts listeners that the mouse has moved over a shape in the diagram. |
|
OnMouseHover | Alerts listeners that the mouse is pointing to an area or an element in the diagram. |
|
OnMouseLeave | Alerts listeners that the mouse is no longer over the shape in the diagram. |
|
OnMouseMove | Alerts listeners that the mouse has been moved over the diagram. |
|
OnMouseUp | Alerts listeners that the user has released the mouse button. |
|
OnMouseWheel | Alerts listeners that the user has rotated the mouse wheel. |
|
ReleaseMouse | Alerts listeners that the user has released the mouse button. |
|
Scrolled | Alerts listeners that the user has scrolled the diagram. |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Top
Events
| Name | Description | |
|---|---|---|
.gif "Public event") |
MouseActionActivated | Occurs when a mouse action starts. |
|
MouseActionDeactivated | Occurs when a mouse action ends. |
Top
Remarks
Derive from this class to create your own custom mouse actions, such as a connector mouse tool.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.