InvokeEditorAction Class
Invokes the editor on click.
Inheritance Hierarchy
System.Object
Microsoft.VisualStudio.Modeling.Diagrams.MouseAction
Microsoft.VisualStudio.Modeling.Diagrams.InvokeEditorAction
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 Class InvokeEditorAction _
Inherits MouseAction
public class InvokeEditorAction : MouseAction
public ref class InvokeEditorAction : public MouseAction
type InvokeEditorAction =
class
inherit MouseAction
end
public class InvokeEditorAction extends MouseAction
The InvokeEditorAction type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
InvokeEditorAction |
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") |
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.) |
Top
Methods
| Name | Description | |
|---|---|---|
|
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.) |
.gif "Protected method") |
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) | Releases all resources, managed and unmanaged, related to this class. (Overrides MouseAction.Dispose(Boolean).) |
|
DoPaintFeedback | Paints the feedback for the mouse action. (Inherited from MouseAction.) |
|
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.) |
|
GetCursor | (Overrides MouseAction.GetCursor(Cursor, DiagramClientView, PointD).) |
|
GetHashCode | Serves as the default hash function. (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 | Invokes the editor and then deactivates this mouse action. (Overrides MouseAction.OnClicked(MouseActionEventArgs).) |
|
OnContextMenuRequested | Alerts listeners that the user has requested the shortcut menu. (Inherited from MouseAction.) |
|
OnDiagramGotFocus | Alerts listeners that the diagram has the focus. (Inherited from MouseAction.) |
|
OnDiagramLostFocus | Called when a LostFocus event has been dispatched to this MouseAction. (Inherited from MouseAction.) |
|
OnDiagramScrolled | Alerts listeners that the user has scrolled the diagram. (Inherited from MouseAction.) |
|
OnDoubleClick | Double-click cancels this mouse action. Double-click should perform the standard default action rather than invoking the editor. (Overrides MouseAction.OnDoubleClick(DiagramPointEventArgs).) |
|
OnDragCanceled | Alerts listeners that the drag operation has been canceled. (Inherited from MouseAction.) |
|
OnDragCompleted | Users tend to drag across the text, thinking they will select the text. Therefore we need to respond to this event and invoke the editor. (Overrides MouseAction.OnDragCompleted(MouseActionEventArgs).) |
|
OnDraggingBegun | Alerts listeners that the drag operation has begun. (Inherited from MouseAction.) |
|
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 | Alerts listeners that the mouse action has begun. (Inherited from MouseAction.) |
|
OnMouseActionCanceled | Alters listeners that the mouse action has been canceled. (Inherited from MouseAction.) |
|
OnMouseActionCompleted | Alerts listeners that the mouse action has completed. (Inherited from MouseAction.) |
|
OnMouseActionDeactivated | Cleans up this mouse action, such as ensuring that the timer is deactivated. (Overrides MouseAction.OnMouseActionDeactivated(DiagramEventArgs).) |
|
OnMouseDown | Saves relevant button information for later use. (Overrides MouseAction.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 | Alerts listeners that the mouse is no longer over the shape in the diagram. (Inherited from MouseAction.) |
|
OnMouseMove | Alerts listeners that the mouse has been moved over the diagram. (Inherited from MouseAction.) |
|
OnMouseUp | Alerts listeners that the user has released the mouse button. (Inherited from MouseAction.) |
|
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.) |
|
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
Remarks
Although this could have been implemented in the OnClick handler of the ShapeField, it wouldn't be possible to focus the field on the first click and invoke the editor on the second click. The first click is handled by the SelectAction, the second click is handled by this InvokeEditorAction.
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.