Share via


ToolboxAction Class

ToolboxAction responds to double-click events on toolbox items.

Inheritance Hierarchy

Object
  Microsoft.VisualStudio.Modeling.Diagrams.MouseAction
    Microsoft.VisualStudio.Modeling.Diagrams.SelectAction
      Microsoft.VisualStudio.Modeling.Diagrams.ToolboxAction

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

Syntax

'Declaration
Public Class ToolboxAction _
    Inherits SelectAction
public class ToolboxAction : SelectAction
public ref class ToolboxAction : public SelectAction
type ToolboxAction =  
    class 
        inherit SelectAction 
    end
public class ToolboxAction extends SelectAction

The ToolboxAction type exposes the following members.

Constructors

  Name Description
Public method ToolboxAction

Top

Properties

  Name Description
Public property CanBumpScroll Gets the mouse action and verifies whether it can cause the diagram to scroll. (Inherited from MouseAction.)
Public property CurrentDiagramArgs Gets the event arguments for the current diagram in which the mouse action occurred. (Inherited from MouseAction.)
Public property CurrentMouseActionEvent Gets the current event for the mouse action. (Inherited from MouseAction.)
Public property CurrentMouseActionState Gets the current state for the mouse action. (Inherited from MouseAction.)
Public property CurrentPoint Gets or sets the mouse position for the current mouse action. (Inherited from MouseAction.)
Protected property DeferredFocusableItem (Inherited from SelectAction.)
Protected property DeferredSelectableItem (Inherited from SelectAction.)
Protected property Diagram Gets the diagram to which the mouse action is assigned. (Inherited from MouseAction.)
Public property HasTooltip Gets the mouse action and verifies whether it can have a tooltip. (Inherited from MouseAction.)
Public property IsActive Gets the mouse action and verifies whether it is active. (Inherited from MouseAction.)
Public property MouseDownHitShape Gets shape over which the mouse action occurred. (Inherited from MouseAction.)
Public property MouseDownPoint Gets the position of the most recent mouse-down event. (Inherited from MouseAction.)
Public property PreviousPoint Gets or sets the position of the previous mouse-down event. (Inherited from MouseAction.)
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. (Inherited from MouseAction.)

Top

Methods

  Name Description
Public method Activate Activates the mouse action. (Inherited from MouseAction.)
Public method CanCancel Gets the mouse action and verifies whether it can be canceled. (Inherited from MouseAction.)
Public method Cancel Cancels the mouse action. (Inherited from MouseAction.)
Public method CanComplete Gets the mouse action and verifies whether it can be completed. (Inherited from MouseAction.)
Protected method CaptureMouse Gets the mouse action. (Inherited from MouseAction.)
Public method Click Performs actions for derived classes when the mouse is clicked. (Inherited from MouseAction.)
Public method Complete Completes the mouse action. (Inherited from MouseAction.)
Public method ContextMenuRequested Sends a request for the shortcut menu. (Inherited from MouseAction.)
Public method Dispose() Releases all resources used by the MouseAction. (Inherited from MouseAction.)
Protected method Dispose(Boolean) Releases the unmanaged resources used by the MouseAction and optionally releases the managed resources. (Inherited from MouseAction.)
Public method DoPaintFeedback Paints the feedback for the mouse action. (Inherited from MouseAction.)
Public method DoubleClick Performs actions for derived classes when a user double-clicks the mouse. (Inherited from MouseAction.)
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. (Inherited from MouseAction.)
Public method GetCursor Gets the cursor to display at the specified mouse position. (Overrides MouseAction.GetCursor(Cursor, DiagramClientView, PointD).)
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. (Inherited from MouseAction.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method GotFocus Assigns the focus to the mouse action. (Inherited from MouseAction.)
Protected method Invalidate Invalidates the feedback from the mouse action. (Inherited from MouseAction.)
Public method LostFocus Removes focus from the mouse action. (Inherited from MouseAction.)
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. (Inherited from MouseAction.)
Public method MouseEnter Performs actions for derived classes when the mouse points to a shape in the diagram. (Inherited from MouseAction.)
Public method MouseHover Performs actions for derived classes when the user points to an area or an element in the diagram. (Inherited from MouseAction.)
Public method MouseLeave Performs actions for derived classes when the mouse no longer points to the shape in the diagram. (Inherited from MouseAction.)
Public method MouseMove Performs actions for derived classes when the user moves the mouse over the diagram. (Inherited from MouseAction.)
Public method MouseUp Performs actions for derived classes when the user releases the mouse button. (Inherited from MouseAction.)
Public method MouseWheel Performs actions for derived classes when the user rotates the mouse wheel. (Inherited from MouseAction.)
Protected method OnClicked Called when this MouseAction has received a non-dragging MouseDown + MouseUp combination or when it has received a Complete event. (Overrides SelectAction.OnClicked(MouseActionEventArgs).)
Protected method OnContextMenuRequested Completes the select action first so that the context menu has a valid selection to work with. (Inherited from SelectAction.)
Protected method OnDiagramGotFocus Alerts listeners that the diagram has the focus. (Inherited from MouseAction.)
Protected method OnDiagramLostFocus Cancels the action if the view loses the focus. (Inherited from SelectAction.)
Protected method OnDiagramScrolled Alerts listeners that the user has scrolled the diagram. (Inherited from MouseAction.)
Protected method OnDoubleClick Alerts listeners that the user has double-clicked the mouse. (Inherited from MouseAction.)
Protected method OnDragCanceled Alerts listeners that the drag operation has been canceled. (Inherited from MouseAction.)
Protected method OnDragCompleted Alerts listeners that the drag operation has been completed. (Inherited from MouseAction.)
Protected method OnDraggingBegun Alerts listeners that the drag operation has begun. (Inherited from MouseAction.)
Protected method OnDraggingEnded Alerts listeners that the drag operation has ended. (Inherited from MouseAction.)
Protected method OnDragPendingBegun Alerts listeners that the drag operation is pending. (Inherited from MouseAction.)
Protected method OnDragPendingEnded Alerts listeners that the drag operation is no longer pending. (Inherited from MouseAction.)
Protected method OnHoveringBegun Alerts listeners that the mouse is hovering over the diagram. (Inherited from MouseAction.)
Protected method OnHoveringEnded Alerts listeners that the mouse is no longer hovering over the diagram. (Inherited from MouseAction.)
Protected method OnMouseActionActivated Alerts listeners that the mouse action has begun. (Inherited from MouseAction.)
Protected method OnMouseActionCanceled Alters listeners that the mouse action has been canceled. (Inherited from MouseAction.)
Protected method OnMouseActionCompleted Alerts listeners that the mouse action has completed. (Inherited from MouseAction.)
Protected method OnMouseActionDeactivated Called when this MouseAction has been deactivated. (Overrides SelectAction.OnMouseActionDeactivated(DiagramEventArgs).)
Protected method OnMouseDown Selects the shape under the mouse. (Inherited from SelectAction.)
Protected method OnMouseEnter Alerts listeners that the mouse has moved over a shape in the diagram. (Inherited from MouseAction.)
Protected method OnMouseHover Alerts listeners that the mouse is pointing to an area or an element in the diagram. (Inherited from MouseAction.)
Protected method OnMouseLeave Alerts listeners that the mouse is no longer over the shape in the diagram. (Inherited from MouseAction.)
Protected method OnMouseMove Called when a MouseMove event has been dispatched to this MouseAction. (Overrides MouseAction.OnMouseMove(DiagramMouseEventArgs).)
Protected method OnMouseUp Alerts listeners that the user has released the mouse button. (Inherited from MouseAction.)
Protected method OnMouseWheel Alerts listeners that the user has rotated the mouse wheel. (Inherited from MouseAction.)
Protected method ReleaseMouse Alerts listeners that the user has released the mouse button. (Inherited from MouseAction.)
Public method Scrolled Alerts listeners that the user has scrolled the diagram. (Inherited from MouseAction.)
Protected method Select Selects the first selectable diagram item (shape, field, or subfield) under the mouse cursor and sets focus to the first item that can receive focus. (Inherited from SelectAction.)
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. (Inherited from MouseAction.)
Public event MouseActionDeactivated Occurs when a mouse action ends. (Inherited from MouseAction.)

Top

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