CreateAction Class
CreateAction responds to select items from toolbox to create them on the diagram.
Inheritance Hierarchy
Object
Microsoft.VisualStudio.Modeling.Diagrams.MouseAction
Microsoft.VisualStudio.Modeling.Diagrams.SelectAction
Microsoft.VisualStudio.Modeling.Diagrams.CreateAction
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 CreateAction _
Inherits SelectAction
public class CreateAction : SelectAction
public ref class CreateAction : public SelectAction
type CreateAction =
class
inherit SelectAction
end
public class CreateAction extends SelectAction
The CreateAction type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
CreateAction | Constructor. |
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 | Override ResetToolboxOnDragDrop to keep the same toolbox selection if this is in sticky mode. (Overrides MouseAction.ResetToolboxOnDragDrop.) |
|
StickyMode | Whether this action is in sticky mode or not. If in sticky mode, after creating one element, the action will not be deactivated, so the user can keep creating more elements of the same type without selecting the item from toolbox again. |
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 the unmanaged resources used by the MouseAction and optionally releases the managed resources. (Inherited from MouseAction.) |
|
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 | Gets the cursor to display at the specified mouse position. (Overrides MouseAction.GetCursor(Cursor, DiagramClientView, PointD).) |
|
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 | Called when this MouseAction has received a non-dragging MouseDown + MouseUp combination or when it has received a Complete event. (Overrides SelectAction.OnClicked(MouseActionEventArgs).) |
|
OnContextMenuRequested | Completes the select action first so that the context menu has a valid selection to work with. (Inherited from SelectAction.) |
|
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 | Alerts listeners that the user has scrolled the diagram. (Inherited from MouseAction.) |
|
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 | Called when this MouseAction's drag operation has completed. When in Sticky mode doesn’t end the action (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 any member variables, such as the deferredSelection member. (Inherited from SelectAction.) |
|
OnMouseDown | Called when a MouseHover event has been dispatched to this MouseAction. (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 | Alerts listeners that the mouse is no longer over the shape in the diagram. (Inherited from MouseAction.) |
|
OnMouseMove | Called when a MouseMove event has been dispatched to this MouseAction. (Overrides MouseAction.OnMouseMove(DiagramMouseEventArgs).) |
|
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.) |
|
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.