Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Mouse action that allows user to drag from one SoftwareComponentType shape or Port shape to another in order to create a connection.
Inheritance Hierarchy
System.Object
Microsoft.VisualStudio.Modeling.Diagrams.MouseAction
Microsoft.VisualStudio.Modeling.Diagrams.SelectAction
Microsoft.VisualStudio.Modeling.Diagrams.ConnectAction
Microsoft.VisualStudio.Modeling.Diagrams.GenericCoreConnectAction
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 ConnectAction _
Inherits SelectAction
public abstract class ConnectAction : SelectAction
public ref class ConnectAction abstract : public SelectAction
[<AbstractClass>]
type ConnectAction =
class
inherit SelectAction
end
public abstract class ConnectAction extends SelectAction
The ConnectAction type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Protected method") |
ConnectAction | Initializes a new instance of the ConnectAction class |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
CanBumpScroll | Gets the mouse action and verifies whether it can cause the diagram to scroll. (Inherited from MouseAction.) |
|
CurrentDiagramArgs | Gets the event arguments for the current diagram in which the mouse action occurred. (Inherited from MouseAction.) |
|
CurrentMouseActionEvent | Gets the current event for the mouse action. (Inherited from MouseAction.) |
|
CurrentMouseActionState | Gets the current state for the mouse action. (Inherited from MouseAction.) |
|
CurrentPoint | Gets or sets the mouse position for the current mouse action. (Inherited from MouseAction.) |
.gif "Protected property") |
DeferredFocusableItem | (Inherited from SelectAction.) |
|
DeferredSelectableItem | (Inherited from SelectAction.) |
|
Diagram | Gets the diagram to which the mouse action is assigned. (Inherited from MouseAction.) |
|
HasTooltip | Gets the mouse action and verifies whether it can have a tooltip. (Inherited from MouseAction.) |
|
IsActive | Gets the mouse action and verifies whether it is active. (Inherited from MouseAction.) |
|
MouseDownHitShape | Gets shape over which the mouse action occurred. (Inherited from MouseAction.) |
|
MouseDownPoint | Gets the position of the most recent mouse-down event. (Inherited from MouseAction.) |
|
PreviousPoint | Gets or sets the position of the previous mouse-down event. (Inherited from MouseAction.) |
|
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.) |
|
StickyMode | Gets/Sets a bool indicating if the connect action can perform multiple connections or not. |
|
TargetPoint | |
|
UpdateConnectionType | External events can determine if connection type should be locked during connect action |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
Activate | Activates the mouse action. (Inherited from MouseAction.) |
|
CanCancel | Gets the mouse action and verifies whether it can be canceled. (Inherited from MouseAction.) |
|
Cancel | Cancels the mouse action. (Inherited from MouseAction.) |
|
CanComplete | Gets the mouse action and verifies whether it can be completed. (Inherited from MouseAction.) |
|
CaptureMouse | Gets the mouse action. (Inherited from MouseAction.) |
|
Click | Performs actions for derived classes when the mouse is clicked. (Inherited from MouseAction.) |
|
Complete | Completes the mouse action. (Inherited from MouseAction.) |
|
ContextMenuRequested | Sends a request for the shortcut menu. (Inherited from MouseAction.) |
|
Dispose() | Releases all resources used by the MouseAction. (Inherited from MouseAction.) |
|
Dispose(Boolean) | (Overrides MouseAction.Dispose(Boolean).) |
|
DoPaintFeedback | Feedbacks usefull information during connect action (Overrides MouseAction.DoPaintFeedback(DiagramPaintEventArgs).) |
|
DoubleClick | Performs actions for derived classes when a user double-clicks the mouse. (Inherited from MouseAction.) |
|
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. (Inherited from MouseAction.) |
|
GetConnectionTypes | Determine from source if a specific connection type exits |
|
GetCursor | Returns the connect action cursor (Overrides MouseAction.GetCursor(Cursor, DiagramClientView, PointD).) |
|
GetCursorFromCursorType | |
|
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
|
GetTooltipText | Gets the tooltip text for an item on the diagram. (Inherited from MouseAction.) |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
GotFocus | Assigns the focus to the mouse action. (Inherited from MouseAction.) |
|
Invalidate | Invalidates the feedback from the mouse action. (Inherited from MouseAction.) |
|
LostFocus | Removes focus from the mouse action. (Inherited from MouseAction.) |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
MouseDown | Performs actions for derived classes when a user clicks the mouse. (Inherited from MouseAction.) |
|
MouseEnter | Performs actions for derived classes when the mouse points to a shape in the diagram. (Inherited from MouseAction.) |
|
MouseHover | Performs actions for derived classes when the user points to an area or an element in the diagram. (Inherited from MouseAction.) |
|
MouseLeave | Performs actions for derived classes when the mouse no longer points to the shape in the diagram. (Inherited from MouseAction.) |
|
MouseMove | Performs actions for derived classes when the user moves the mouse over the diagram. (Inherited from MouseAction.) |
|
MouseUp | Performs actions for derived classes when the user releases the mouse button. (Inherited from MouseAction.) |
|
MouseWheel | Performs actions for derived classes when the user rotates the mouse wheel. (Inherited from MouseAction.) |
|
OnClicked | (Overrides SelectAction.OnClicked(MouseActionEventArgs).) |
|
OnContextMenuRequested | Should cancel connect action on context menu as it throws exceptions otherwise because target and source elements could be null in this case. (Overrides SelectAction.OnContextMenuRequested(DiagramMouseEventArgs).) |
|
OnDiagramGotFocus | Alerts listeners that the diagram has the focus. (Inherited from MouseAction.) |
|
OnDiagramLostFocus | Cancels the action if the view loses the focus. (Inherited from SelectAction.) |
|
OnDiagramScrolled | Called when a Scrolled event has been dispatched to this MouseAction. (Overrides MouseAction.OnDiagramScrolled(DiagramEventArgs).) |
|
OnDoubleClick | Alerts listeners that the user has double-clicked the mouse. (Inherited from MouseAction.) |
|
OnDragCanceled | Alerts listeners that the drag operation has been canceled. (Inherited from MouseAction.) |
|
OnDragCompleted | (Overrides MouseAction.OnDragCompleted(MouseActionEventArgs).) |
|
OnDraggingBegun | (Overrides MouseAction.OnDraggingBegun(MouseActionEventArgs).) |
|
OnDraggingEnded | Alerts listeners that the drag operation has ended. (Inherited from MouseAction.) |
|
OnDragPendingBegun | Alerts listeners that the drag operation is pending. (Inherited from MouseAction.) |
|
OnDragPendingEnded | Alerts listeners that the drag operation is no longer pending. (Inherited from MouseAction.) |
|
OnHoveringBegun | Alerts listeners that the mouse is hovering over the diagram. (Inherited from MouseAction.) |
|
OnHoveringEnded | Alerts listeners that the mouse is no longer hovering over the diagram. (Inherited from MouseAction.) |
|
OnMouseActionActivated | (Overrides MouseAction.OnMouseActionActivated(DiagramEventArgs).) |
|
OnMouseActionCanceled | (Overrides MouseAction.OnMouseActionCanceled(DiagramEventArgs).) |
|
OnMouseActionCompleted | Alerts listeners that the mouse action has completed. (Inherited from MouseAction.) |
|
OnMouseActionDeactivated | (Overrides SelectAction.OnMouseActionDeactivated(DiagramEventArgs).) |
|
OnMouseDown | (Overrides SelectAction.OnMouseDown(DiagramMouseEventArgs).) |
|
OnMouseEnter | Alerts listeners that the mouse has moved over a shape in the diagram. (Inherited from MouseAction.) |
|
OnMouseHover | Alerts listeners that the mouse is pointing to an area or an element in the diagram. (Inherited from MouseAction.) |
|
OnMouseLeave | (Overrides MouseAction.OnMouseLeave(LeaveShapeEventArgs).) |
|
OnMouseMove | (Overrides MouseAction.OnMouseMove(DiagramMouseEventArgs).) |
|
OnMouseUp | (Overrides MouseAction.OnMouseUp(DiagramMouseEventArgs).) |
|
OnMouseWheel | Alerts listeners that the user has rotated the mouse wheel. (Inherited from MouseAction.) |
|
ReleaseMouse | Alerts listeners that the user has released the mouse button. (Inherited from MouseAction.) |
|
Scrolled | Alerts listeners that the user has scrolled the diagram. (Inherited from MouseAction.) |
|
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.) |
|
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. (Inherited from MouseAction.) |
|
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.