ConnectAction Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Mouse action that allows user to drag from one SoftwareComponentType shape or Port shape to another in order to create a connection.
public ref class ConnectAction abstract : Microsoft::VisualStudio::Modeling::Diagrams::SelectActionpublic abstract class ConnectAction : Microsoft.VisualStudio.Modeling.Diagrams.SelectActiontype ConnectAction = class
inherit SelectActionPublic MustInherit Class ConnectAction
Inherits SelectAction- Inheritance
- Derived
Constructors
| ConnectAction(Diagram, Boolean) |
Initializes a new instance of the ConnectAction class |
Properties
| CanBumpScroll |
Called when a MouseMove event has been dispatched to this MouseAction. (Inherited from MouseAction) |
| CurrentDiagramArgs |
Gets the latest DiagramEventArgs. A null value may be returned. (Inherited from MouseAction) |
| CurrentMouseActionEvent |
Gets the current MouseAction event. (Inherited from MouseAction) |
| CurrentMouseActionState |
Gets the current MouseAction state. (Inherited from MouseAction) |
| CurrentPoint |
Gets/Sets the mouse position for the current event. The position is in world units relative to the diagram's top-left. (Inherited from MouseAction) |
| DeferredFocusableItem |
Gets the item that will become the selection's focused item if and when the OnClicked event occurs. (Inherited from SelectAction) |
| DeferredSelectableItem |
Gets the item that the selection will be set to if and when the OnClicked event occurs. (Inherited from SelectAction) |
| Diagram |
The Diagram to which this MouseAction belongs. (Inherited from MouseAction) |
| HasTooltip |
Gets whether this mouse action supports dynamic tooltip. (Inherited from MouseAction) |
| IsActive |
Gets a value indicating whether this MouseAction is currently active. (Inherited from MouseAction) |
| MouseDownHitShape |
Gets the hit shape of the most recent MouseDown event. (Inherited from MouseAction) |
| MouseDownPoint |
Gets the mouse position of the most recent MouseDown event. The position is in world units relative to the diagram's top-left. (Inherited from MouseAction) |
| PreviousPoint |
Gets/Sets the mouse position of the previous event. The position is in world units relative to the diagram's top-left. (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 |
Methods
| Activate(DiagramClientView) |
Activates this MouseAction. (Inherited from MouseAction) |
| CanCancel(DiagramClientView) |
Gets a value indicating whether this MouseAction can be canceled. (Inherited from MouseAction) |
| Cancel(DiagramClientView) |
Cancels this MouseAction. (Inherited from MouseAction) |
| CanComplete(DiagramClientView) |
Gets a value indicating whether this MouseAction can be completed. (Inherited from MouseAction) |
| CaptureMouse(DiagramClientView) |
Captures the mouse. (Inherited from MouseAction) |
| Click(DiagramPointEventArgs) |
Called by the DiagramClientView to dispatch a Click event to this MouseAction. (Inherited from MouseAction) |
| Complete(DiagramClientView) |
Completes this MouseAction. (Inherited from MouseAction) |
| ContextMenuRequested(DiagramMouseEventArgs) |
Called by the DiagramClientView to dispatch a ContextMenu event to this MouseAction. (Inherited from MouseAction) |
| Dispose() | (Inherited from MouseAction) |
| Dispose(Boolean) | |
| DoPaintFeedback(DiagramPaintEventArgs) |
Feedbacks usefull information during connect action |
| DoubleClick(DiagramPointEventArgs) |
Called by the DiagramClientView to dispatch a DoubleClick event to this MouseAction. (Inherited from MouseAction) |
| GetConnectionTypes(ShapeElement, ShapeElement) |
Determine from source if a specific connection type exits |
| GetCursor(Cursor, DiagramClientView, PointD) |
Returns the connect action cursor |
| GetCursorFromCursorType(ConnectActionCursor) | |
| GetTooltipText(DiagramItem) |
Gets tooltip text for specified diagram item if HasTooltip returned true. (Inherited from MouseAction) |
| GotFocus(DiagramEventArgs) |
Called by the DiagramClientView to dispatch a GotFocus event to this MouseAction. (Inherited from MouseAction) |
| Invalidate(DiagramClientView) |
Called by this MouseAction to invalidate its feedback. (Inherited from MouseAction) |
| LostFocus(DiagramEventArgs) |
Called by the DiagramClientView to dispatch a LostFocus event to this MouseAction. (Inherited from MouseAction) |
| MouseDown(DiagramMouseEventArgs) |
Called by the DiagramClientView to dispatch a MouseDown event to this MouseAction. (Inherited from MouseAction) |
| MouseEnter(DiagramPointEventArgs) |
Called by the DiagramClientView to dispatch a MouseEnter event to this MouseAction. (Inherited from MouseAction) |
| MouseHover(DiagramPointEventArgs) |
Called by the DiagramClientView to dispatch a MouseHover event to this MouseAction. (Inherited from MouseAction) |
| MouseLeave(LeaveShapeEventArgs) |
Called by the DiagramClientView to dispatch a MouseLeave event to this MouseAction. (Inherited from MouseAction) |
| MouseMove(DiagramMouseEventArgs) |
Called by the DiagramClientView to dispatch a MouseMove event to this MouseAction. (Inherited from MouseAction) |
| MouseUp(DiagramMouseEventArgs) |
Called by the DiagramClientView to dispatch a MouseUp event to this MouseAction. (Inherited from MouseAction) |
| MouseWheel(DiagramMouseEventArgs) |
Called by the DiagramClientView to dispatch a ContextMenuRequested event to this MouseAction. (Inherited from MouseAction) |
| OnClicked(MouseActionEventArgs) | |
| OnContextMenuRequested(DiagramMouseEventArgs) |
Should cancel connect action on context menu as it throws exceptions otherwise because target and source elements could be null in this case. |
| OnDiagramGotFocus(DiagramEventArgs) |
Called when a GotFocus event has been dispatched to this MouseAction. (Inherited from MouseAction) |
| OnDiagramLostFocus(LostFocusEventArgs) |
Cancels the action if the view loses the focus. (Inherited from SelectAction) |
| OnDiagramScrolled(DiagramEventArgs) |
Called when a Scrolled event has been dispatched to this MouseAction. |
| OnDoubleClick(DiagramPointEventArgs) |
Called when a DoubleClick event has been dispatched to this MouseAction. (Inherited from MouseAction) |
| OnDragCanceled(MouseActionEventArgs) |
Called when this MouseAction's drag operation has been canceled. (Inherited from MouseAction) |
| OnDragCompleted(MouseActionEventArgs) | |
| OnDraggingBegun(MouseActionEventArgs) | |
| OnDraggingEnded(MouseActionEventArgs) |
Called when this MouseAction has exited the dragging state. (Inherited from MouseAction) |
| OnDragPendingBegun(MouseActionEventArgs) |
Called when this MouseAction has entered the drag/click-pending state. (Inherited from MouseAction) |
| OnDragPendingEnded(MouseActionEventArgs) |
Called when this MouseAction has exited the drag/click-pending state. (Inherited from MouseAction) |
| OnHoveringBegun(MouseActionEventArgs) |
Called when this MouseAction has entered the hovering state. (Inherited from MouseAction) |
| OnHoveringEnded(MouseActionEventArgs) |
Called when this MouseAction has exited the hovering state. (Inherited from MouseAction) |
| OnMouseActionActivated(DiagramEventArgs) | |
| OnMouseActionCanceled(DiagramEventArgs) | |
| OnMouseActionCompleted(DiagramEventArgs) |
Called when the MouseAction has completed and is ready to be deactivated. (Inherited from MouseAction) |
| OnMouseActionDeactivated(DiagramEventArgs) | |
| OnMouseDown(DiagramMouseEventArgs) | |
| OnMouseEnter(DiagramPointEventArgs) |
Called when a MouseEnter event has been dispatched to this MouseAction. (Inherited from MouseAction) |
| OnMouseHover(DiagramPointEventArgs) |
Called when a MouseHover event has been dispatched to this MouseAction. (Inherited from MouseAction) |
| OnMouseLeave(LeaveShapeEventArgs) | |
| OnMouseMove(DiagramMouseEventArgs) | |
| OnMouseUp(DiagramMouseEventArgs) | |
| OnMouseWheel(DiagramMouseEventArgs) |
Called when a MouseWheel event has been dispatched to this MouseAction. (Inherited from MouseAction) |
| ReleaseMouse(DiagramClientView) |
Releases the mouse capture. (Inherited from MouseAction) |
| Scrolled(DiagramEventArgs) |
Called by the DiagramClientView to dispatch a Scrolled event to this MouseAction. (Inherited from MouseAction) |
| Select(DiagramMouseEventArgs) |
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) |
Events
| MouseActionActivated |
Occurs when the MouseAction is activated. (Inherited from MouseAction) |
| MouseActionDeactivated |
Occurs when the MouseAction is deactivated. (Inherited from MouseAction) |