Freigeben über

MouseAction Class

  • Artikel

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.10.0 (in Microsoft.VisualStudio.Modeling.Sdk.Diagrams.10.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
Protected method MouseAction() Initializes a new instance of the MouseAction class.
Protected method MouseAction(Diagram) Initializes a new instance of the MouseAction class.

Top

Properties

  Name Description
Public propertyStatic member ActionCanceledState Gets the canceled state for the mouse action.
Public propertyStatic member ActionCompletedState Gets the completed state for the mouse action.
Public property CanBumpScroll Gets the mouse action and verifies whether it can cause the diagram to scroll.
Public propertyStatic member ClickedState Gets the clicked state for the mouse action.
Public property CurrentDiagramArgs Gets the event arguments for the current diagram in which the mouse action occurred.
Public property CurrentMouseActionEvent Gets the current event for the mouse action.
Public property CurrentMouseActionState Gets the current state for the mouse action.
Public property CurrentPoint Gets or sets the mouse position for the current mouse action.
Protected property Diagram Gets the diagram to which the mouse action is assigned.
Public propertyStatic member DragCanceledState Gets the drag cancellation state for the mouse action.
Public propertyStatic member DragCompletedState Gets the drag completion state for the mouse action.
Public propertyStatic member DraggingState Gets the drag state of the mouse action.
Public propertyStatic member DragPendingState Gets the pending drag state for the mouse action.
Public property HasTooltip Gets the mouse action and verifies whether it can have a tooltip.
Public propertyStatic member HoveringState Gets the hovering state for the mouse action.
Public propertyStatic member InactiveState Gets the inactive state for the mouse action.
Public property IsActive Gets the mouse action and verifies whether it is active.
Public property MouseDownHitShape Gets shape over which the mouse action occurred.
Public property MouseDownPoint Gets the position of the most recent mouse-down event.
Public property PreviousPoint Gets or sets the position of the previous mouse-down event.
Public property 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
Public method Activate Activates the mouse action.
Public method CanCancel Gets the mouse action and verifies whether it can be canceled.
Public method Cancel Cancels the mouse action.
Public method CanComplete Gets the mouse action and verifies whether it can be completed.
Protected method CaptureMouse Gets the mouse action.
Public method Click Performs actions for derived classes when the mouse is clicked.
Public method Complete Completes the mouse action.
Public method ContextMenuRequested Sends a request for the shortcut menu.
Public method Dispose() Releases all resources used by the MouseAction.
Protected method Dispose(Boolean) Releases the unmanaged resources used by the MouseAction and optionally releases the managed resources.
Public method DoPaintFeedback Paints the feedback for the mouse action.
Public method DoubleClick Performs actions for derived classes when a user double-clicks the mouse.
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Finalizes the mouse action but does not dispose it. (Overrides Object.Finalize().)
Public method GetCursor Gets the pointer to display for the mouse.
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetTooltipText Gets the tooltip text for an item on the diagram.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method GotFocus Assigns the focus to the mouse action.
Protected method Invalidate Invalidates the feedback from the mouse action.
Public method LostFocus Removes focus from the mouse action.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method MouseDown Performs actions for derived classes when a user clicks the mouse.
Public method MouseEnter Performs actions for derived classes when the mouse points to a shape in the diagram.
Public method MouseHover Performs actions for derived classes when the user points to an area or an element in the diagram.
Public method MouseLeave Performs actions for derived classes when the mouse no longer points to the shape in the diagram.
Public method MouseMove Performs actions for derived classes when the user moves the mouse over the diagram.
Public method MouseUp Performs actions for derived classes when the user releases the mouse button.
Public method MouseWheel Performs actions for derived classes when the user rotates the mouse wheel.
Protected method OnClicked Alerts listeners that the user has clicked the mouse.
Protected method OnContextMenuRequested Alerts listeners that the user has requested the shortcut menu.
Protected method OnDiagramGotFocus Alerts listeners that the diagram has the focus.
Protected method OnDiagramLostFocus Called when a LostFocus event has been dispatched to this MouseAction.
Protected method OnDiagramScrolled Alerts listeners that the user has scrolled the diagram.
Protected method OnDoubleClick Alerts listeners that the user has double-clicked the mouse.
Protected method OnDragCanceled Alerts listeners that the drag operation has been canceled.
Protected method OnDragCompleted Alerts listeners that the drag operation has been completed.
Protected method OnDraggingBegun Alerts listeners that the drag operation has begun.
Protected method OnDraggingEnded Alerts listeners that the drag operation has ended.
Protected method OnDragPendingBegun Alerts listeners that the drag operation is pending.
Protected method OnDragPendingEnded Alerts listeners that the drag operation is no longer pending.
Protected method OnHoveringBegun Alerts listeners that the mouse is hovering over the diagram.
Protected method OnHoveringEnded Alerts listeners that the mouse is no longer hovering over the diagram.
Protected method OnMouseActionActivated Alerts listeners that the mouse action has begun.
Protected method OnMouseActionCanceled Alters listeners that the mouse action has been canceled.
Protected method OnMouseActionCompleted Alerts listeners that the mouse action has completed.
Protected method OnMouseActionDeactivated Alerts listeners that the mouse action has been deactivated.
Protected method OnMouseDown Alerts listeners that the mouse has been clicked.
Protected method OnMouseEnter Alerts listeners that the mouse has moved over a shape in the diagram.
Protected method OnMouseHover Alerts listeners that the mouse is pointing to an area or an element in the diagram.
Protected method OnMouseLeave Alerts listeners that the mouse is no longer over the shape in the diagram.
Protected method OnMouseMove Alerts listeners that the mouse has been moved over the diagram.
Protected method OnMouseUp Alerts listeners that the user has released the mouse button.
Protected method OnMouseWheel Alerts listeners that the user has rotated the mouse wheel.
Protected method ReleaseMouse Alerts listeners that the user has released the mouse button.
Public method Scrolled Alerts listeners that the user has scrolled the diagram.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Events

  Name Description
Public event MouseActionActivated Occurs when a mouse action starts.
Public event 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.

See Also

Reference

Microsoft.VisualStudio.Modeling.Diagrams Namespace