Diagram Methods

Include Protected Members
Include Inherited Members

The Diagram type exposes the following members.

Methods

 

Name

Description

Public method

AccessibleDoDefaultAction

Performs the default action for the accessible object. (Inherited from ShapeElement.)

Public method

AddImageFormat

Adds the format of the diagram image to IDataObject, which is responsible for transferring data.

Public method

Associate

Overloaded.

Public method

AutoLayoutChildShapes

Positions the collection of shapes in the diagram automatically. (Inherited from NodeShape.)

Public method

AutoLayoutShapeElements

Overloaded. Lays out the collection of element shapes on the diagram automatically.

Protected method

CalculateDerivedVisible

Verifies whether the child shape appears. (Inherited from ShapeElement.)

Public method

CalculateMinimumSizeBasedOnChildren

Calculates the minimum size needed so that the shape can include its child shapes. (Inherited from NodeShape.)

Protected method

CanMerge

Verifies whether a source element can be added to this element. (Inherited from ModelElement.)

Protected method

ChooseMergeTarget

Overloaded. Selects a target element that the root element should merge with.

Public method

ChooseParentShape

Selects a parent shape for a new child shape, typically this shape. (Inherited from ShapeElement.)

Protected method

ChooseRelationship

Called by FixUpChildShapes() to get the relationship to create between the child shape and its parent shape. (Inherited from NodeShape.)

Public method

CoerceSelection

Allows a shape to determine which other shapes are selected. (Inherited from ShapeElement.)

Protected method

Collapse

Collapses the shape so that its nested child shapes are not visible. (Inherited from NodeShape.)

Protected method

ConfiguredChildPortShape

Configures a child port shape and positions it, if necessary. (Inherited from NodeShape.)

Public method

Copy

Overloaded. Creates a copy of this element in the model.

Public method

CopyImageToClipboard

Copies a collection of shapes and their parent shapes to the Clipboard as an image.

Protected method

CreateBackgroundGradientField

Creates the area field, which displays the gradient fill in the background of the shape. (Inherited from NodeShape.)

Public method

CreateBitmap

Creates an image of the selected shapes.

Protected method

CreateChildShape

Creates a child shape for the parent shape. (Overrides ShapeElement.CreateChildShape(ModelElement).)

Protected method

CreateClassStyleSet

Creates a class style set for the shape type. (Inherited from ShapeElement.)

Public method

CreateConnectionPoint

A connection point is a point on the edge of a shape at which connectors are terminated in preference to other points on the edge. (Inherited from NodeShape.)

Protected method

CreateDecorators

Creates a collection of decorators for the shape type. (Inherited from ShapeElement.)

Public method

CreateDefaultBounds

Creates default bounding rectangle for the shape. (Inherited from NodeShape.)

Protected method

CreateInstanceStyleSet

Creates a style set for the shape. (Inherited from ShapeElement.)

Public method

CreateManualRouteAction

Creates the mouse action for manual link routing.

Public method

CreateMetafile

Overloaded. Creates a metafile for the specified shapes and their child shapes.

Protected method

CreateShapeFields

Creates a collection of shape fields for the shape type. (Inherited from ShapeElement.)

Public method

Delete

Overloaded. Deletes the element from the model.

Protected method

DetermineHighlightShape

Finds the highlighted shape in a chain of shapes. (Inherited from ShapeElement.)

Public method

Disassociate

Removes the diagram from the specified diagram view.

Public method

Dispose

Overloaded. Releases the resources used by the Diagram.

Public method

DoFoldToShape

Calculates the point where a connector will touch the perimeter of a shape. Override this if you define a non-rectangular shape. (Inherited from ShapeElement.)

Public method

DoHitTest

Overloaded. Performs a hit test on the diagram.

Public method

DoHitTestSelection

Returns true if a given point is in the selection handles around the shape. (Inherited from ShapeElement.)

Public method

DoKeyboardNavigation

Navigates the from shape to shape, using the keyboard. (Inherited from ShapeElement.)

Public method

DrawResizeFeedback

Draws the resizing feedback for the shape. (Inherited from ShapeElement.)

Public method

EnsureConnectionPoints

Override to set points on the edge of the shape at which connectors should terminate. (Inherited from NodeShape.)

Protected method

EnsureGraphExists

Verifies whether the grid exists for the shape. (Inherited from NodeShape.)

Protected method

EnsureGraphLayoutObjectsExist

Verifies whether the shape and its child shapes are in the graph wrapper. (Inherited from NodeShape.)

Public method

Equals

Determines whether the specified Object is equal to the current Object. (Inherited from Object.)

Public method

ExcludeFromClipRegion

Excludes the shape and its child shapes from the clipping region. (Inherited from ShapeElement.)

Public method

ExcludeGeometryFromClipRegion

Excludes the geometry of a shape and its child shapes from the clipping region. (Inherited from ShapeElement.)

Protected method

Expand

Expands the shape so that its nested child shapes are visible and fit inside it. (Inherited from NodeShape.)

Protected method

Finalize

Allows the diagram to try to free resources and perform other cleanup operations before it is reclaimed by the garbage collector. Called by the garbage collector. (Overrides Object.Finalize().)

Public method

FindDecorator

Finds the shape decorator that has a given name. (Inherited from ShapeElement.)

Public method

FindFirstChild

Searches for the first child in the navigation sequence for the shape. (Inherited from ShapeElement.)

Public method

FindFreeArea

Overloaded. Finds an empty area in the graph for the shape.

Public method

FindLastChild

Searches for the last child in the navigation sequence for the shape. (Inherited from ShapeElement.)

Public method

FindNextChild

Searches for the next child in the navigation sequence for the shape. (Inherited from ShapeElement.)

Public method

FindNextInChildFields

Searches for the next shape field in the navigation sequence. (Inherited from ShapeElement.)

Public method

FindPreviousChild

Searches for the previous child in the navigation sequence for the shape. (Inherited from ShapeElement.)

Public method

FindPreviousInChildFields

Searches for the previous shape field in the navigation sequence. (Inherited from ShapeElement.)

Public method

FindShape

Finds the shape for the specified element on the diagram.

Public method

FindShapeField

Searches for a shape field in a shape. (Inherited from ShapeElement.)

Public method

FixUpChildShapes

Creates or adjusts the child shapes that should be created when a model element is created or updated. Called by Diagram.FixUpDiagram(). (Inherited from ShapeElement.)

Public methodStatic member

FixUpDiagram

Ensures that the shape and its parent shapes are created and configured correctly.

Public method

FixUpDiagramSelection

Updates the selection in the diagram.

Public method

Focused

Verifies whether the shape has the focus. (Inherited from ShapeElement.)

Protected method

GetAbsoluteBoundsValue

Gets the absolute bounds for the shape. (Inherited from NodeShape.)

Public method

GetAccessibilityObject

Gets the accessible object that is assigned to the shape. (Inherited from ShapeElement.)

Public method

GetChildElements

Gets a collection of child shapes that belong to the parent shape. (Inherited from ShapeElement.)

Public method

GetCompliantAnchorPoint

Gets a new, valid anchor point for the shape. (Inherited from NodeShape.)

Public method

GetCompliantGroupBounds

Updates the collection of ghost shapes so that it complies with the source shape's group bounds rules.

Public method

GetCursor

Gets the pointer that appears when the mouse is over the shape. (Inherited from ShapeElement.)

Public method

GetDomainClass

Gets the most-derived domain class for this element. (Inherited from ModelElement.)

Public method

GetDragOverToolTipText

Gets the tooltip text that appears when the mouse is over the shape. (Inherited from ShapeElement.)

Public method

GetFieldAccessibleDescription

Gets the description for a field in the shape. (Inherited from ShapeElement.)

Public method

GetFieldAccessibleName

Gets the name of a field in the shape. (Inherited from ShapeElement.)

Public method

GetFieldAccessibleValue

Gets the value for a field in the shape. (Inherited from ShapeElement.)

Public method

GetFieldRepresentedElement

Gets the primary element that the child shape represents. (Inherited from ShapeElement.)

Public method

GetFieldRepresentedProperty

Gets the property information for a field in the shape. (Inherited from ShapeElement.)

Public method

GetHashCode

Serves as a hash function for a particular type. (Inherited from Object.)

Protected method

GetIsExpandedValue

Gets the value for the IsExpanded property. (Inherited from NodeShape.)

Public method

GetPotentialMouseAction

Gets the mouse action to initiate when the user clicks a point in the diagram. (Overrides ShapeElement.GetPotentialMouseAction(MouseButtons, PointD, DiagramHitTestInfo).)

Public method

GetService

Gets a service.

Public method

GetShapeLuminosity

Calculates the luminosity of the shape. (Inherited from ShapeElement.)

Protected method

GetSourceRolePlayerForLinkMappedByConnector

Gets the source role for the link shape.

Public method

GetSubFieldAccessibleDescription

Gets the description for a child field in the shape. (Inherited from ShapeElement.)

Public method

GetSubFieldAccessibleName

Gets the name of a child field in the shape. (Inherited from ShapeElement.)

Public method

GetSubFieldAccessibleValue

Gets the value for a child field in the shape. (Inherited from ShapeElement.)

Public method

GetSubFieldRepresentedElements

Gets a collection of elements that the shape for the child field represents. (Inherited from ShapeElement.)

Public method

GetSubFieldRepresentedProperty

Gets the property for the child field. (Inherited from ShapeElement.)

Public method

GetSubFieldRepresentedPropertyElements

Gets the element that contains the property for the child field. (Inherited from ShapeElement.)

Protected method

GetTargetRolePlayerForLinkMappedByConnector

Gets the target role for the link shape.

Public method

GetToolTipText

Gets the tooltip text for the shape to which the mouse is pointing. (Inherited from ShapeElement.)

Public method

GetType

Gets the type of the current instance. (Inherited from Object.)

Public method

HandleNewSwimLaneInsertion

Adds a swimlane to the diagram.

Protected method

HasCachedDragOverResult

Verifies whether the results are cached for the drag-over mouse event. (Inherited from ShapeElement.)

Public method

Hide

Hides the shape and all its children. (Inherited from ShapeElement.)

Protected method

HideCustomToolTip

Hides the custom tooltip for the shape. (Inherited from ShapeElement.)

Public method

HitTest

Gets the shapes to include in the hit test.

Protected method

InitializeDecorators

Initializes and adds fields to the shape type. (Inherited from ShapeElement.)

Protected method

InitializeInstanceResources

Initializes the resources for an instance of the shape. (Inherited from ShapeElement.)

Protected method

InitializeResources

Initializes the resources for the shape. (Inherited from ShapeElement.)

Protected method

InitializeShapeFields

Provides support for background gradients. (Inherited from NodeShape.)

Public method

Invalidate

Overloaded.

Public method

InvalidateRectangle

Invalidates the shapes that are in the selection rectangle.

Public method

IsConnectorMappedToLink

Verifies whether the link has a link shape on the diagram.

Public method

IsDescendantOf

Verifies whether the shape is a descendent of another shape. (Inherited from ShapeElement.)

Protected method

IsNavigationKey

Overloaded. Verifies whether the key is used for navigation in the shape.

Public method

IsOrphaned

Verifies whether a shape is linked to another shape in the diagram.

Public method

IsSelected

Verifies whether a shape is selected in a diagram view.

Public method

IterateShapes

Iterates through a shape and its child shapes. (Inherited from ShapeElement.)

Public method

LassoSelect

Gets the list of shapes that are in the selection rectangle.

Protected method

MemberwiseClone

Creates a shallow copy of the current Object. (Inherited from Object.)

Protected method

MergeConfigure

Not used for presentation elements. (Inherited from PresentationElement.)

Protected method

MergeDisconnect

Disconnects a source element from a target element. (Inherited from ModelElement.)

Protected method

MergeRelate

Creates a relationship between a model element and a group of model elements. (Inherited from PresentationElement.)

Protected method

ModifyLuminosity

Calculates the luminosity of the highlight for the shape. (Inherited from ShapeElement.)

Public method

MoveByRepositioning

Overloaded. Repositions the shapes in the group by the amount that the position of the mouse determines.

Public method

NavigateAcrossLinks

Selects the shapes or sets the focus on the shapes that are connected to this shape. (Inherited from NodeShape.)

Public method

NavigateAscend

Navigates to the next ancestor in the navigation sequence and updates the focus. Called in response to user navigation keystrokes. (Inherited from ShapeElement.)

Public method

NavigateDescend

Navigates to the next descendent in the navigation sequence and updates the focus. Called in response to user navigation keystrokes. (Inherited from ShapeElement.)

Protected method

NavigateTo

Navigates to a specific shape in the navigation sequence and updates the focus. (Inherited from ShapeElement.)

Public method

NavigateToFirst

Navigates to the first shape in the navigation sequence in the parent of the current selection. Called in response to user navigation keystrokes. (Inherited from ShapeElement.)

Public method

NavigateToLast

Navigates to the last shape in the navigation sequence in the parent of the current selection. Called in response to user navigation keystrokes. (Inherited from ShapeElement.)

Public method

NavigateToNext

Navigates to the next shape in the navigation sequence. Called in response to user navigation keystrokes. (Inherited from ShapeElement.)

Public method

NavigateToPrevious

Navigates to the previously selected shape in the navigation sequence. Called in response to user navigation keystrokes. (Inherited from ShapeElement.)

Public method

OnAbsoluteBoundsChanged

Called when the size or location of the shape have changed. (Inherited from NodeShape.)

Protected method

OnAssociated

Performs an action when the diagram has been associated with a diagram view.

Protected method

OnAssociatedPropertyChanged

Updates the shape when the value of an in-memory store property changes for a field in the shape. (Inherited from ShapeElement.)

Protected method

OnBeforePaint

Updates resources, such as pens and brushes, before they are used to paint the shape. (Inherited from ShapeElement.)

Public method

OnBeforeReroute

Performs an action when a link is about to be rerouted in the diagram.

Public method

OnBeginEdit

Called when the user starts to edit a text field. (Inherited from ShapeElement.)

Public method

OnBoundsFixup

Override this method to customize how the bounds for the shape are determined. (Inherited from NodeShape.)

Protected method

OnChildAssociatedPropertyChanged

Performs an action when a property that is associated with a child shape has changed.

Protected method

OnChildConfigured

Configures a port on the shape after the shape is added to the diagram. (Inherited from NodeShape.)

Protected method

OnChildConfiguring

Performs an action when a child shape has been configured. (Overrides NodeShape.OnChildConfiguring(ShapeElement, Boolean).)

Public method

OnClick

Called when the user clicks the shape. (Inherited from ShapeElement.)

Protected method

OnCopy

Alerts listeners that a copy of the element has been created. (Inherited from ModelElement.)

Protected method

OnDeleted

Alerts listeners that an element has been deleted from the model. (Inherited from ModelElement.)

Protected method

OnDeleting

Alerts listeners that the element is being deleted. (Inherited from ModelElement.)

Protected method

OnDisassociated

Performs an action when the diagram is disassociated from a diagram view.

Public method

OnDoubleClick

Called when the user double-clicks the shape. (Inherited from ShapeElement.)

Public method

OnDragDrop

Called when the user drags an item onto the shape. (Inherited from ShapeElement.)

Public method

OnDragEnter

Called when the mouse enters a shape during a drag operation. (Inherited from ShapeElement.)

Public method

OnDragLeave

Called when the mouse moves out of a shape. (Inherited from ShapeElement.)

Public method

OnDragOver

Override this method to respond to the movement of the mouse over the shape. Set e.Effect to indicate the cursor feedback to the user. (Inherited from ShapeElement.)

Public method

OnElementEventsEnded

Raises an event after all other events for a transaction have been raised.

Public method

OnElementEventsEnding

Raises an event after all other events for a transaction have been raised.

Public method

OnEndEdit

Called when the user ends editing a text field. (Inherited from ShapeElement.)

Public method

OnGiveFeedback

Changes the pointer and performs a custom action when the pointer is dragged across the designer.

Public method

OnGridPropertyChanged

Performs an action when the grid properties have changed.

Public method

OnInitialize

Performs an action when the Diagram class is initialized. (Overrides ShapeElement.OnInitialize().)

Public method

OnKeyDown

Performs an action when the user presses a key while the diagram has the focus. (Overrides NodeShape.OnKeyDown(DiagramKeyEventArgs).)

Public method

OnKeyPress

Alerts listeners that a key has been pressed. (Inherited from NodeShape.)

Public method

OnKeyUp

Called when a key is released. (Inherited from ShapeElement.)

Public method

OnMouseDown

Called when the user presses a mouse key. (Inherited from ShapeElement.)

Public method

OnMouseEnter

Called when the mouse enters a shape. (Inherited from ShapeElement.)

Public method

OnMouseHover

Called when the mouse hovers over a shape. (Inherited from ShapeElement.)

Public method

OnMouseLeave

Called when the mouse leaves a shape. (Inherited from ShapeElement.)

Public method

OnMouseMove

Called repeatedly when the user moves the mouse. (Inherited from ShapeElement.)

Public method

OnMouseUp

Called when a mouse button is released. (Inherited from ShapeElement.)

Public method

OnMouseWheel

Called when the user has rotated the mouse wheel. (Inherited from ShapeElement.)

Public method

OnOrphaned

Called when a (Inherited from ShapeElement.)

Public method

OnPaintEmphasis

Called when emphasis has been applied to the selected shape. (Inherited from ShapeElement.)

Public method

OnPaintFeedback

Called when drag-and-drop feedback is painted. (Inherited from ShapeElement.)

Public method

OnPaintSelection

Called to paint the selection highlight. (Inherited from ShapeElement.)

Public method

OnPaintShape

Lets derived classes perform an action when the diagram background and grid are painted. (Overrides ShapeElement.OnPaintShape(DiagramPaintEventArgs).)

Protected method

OnResurrected

Alerts listeners that an element has been added back to a model. (Inherited from ModelElement.)

Protected method

OnRolePlayerPositionChanged

Alerts listeners that the position of a role is about to change. (Inherited from ModelElement.)

Protected method

OnRolePlayerPositionChanging

Allows notification when a role player position has changed. (Inherited from ModelElement.)

Public method

OnShapeInserted

Called when a shape has been inserted as a child of another. (Inherited from ShapeElement.)

Public method

OnShapeRemoved

Called when the shape has been removed as a child shape from its parent shape. (Inherited from ShapeElement.)

Public method

OnTransactionBeginning

Lets derived classes perform an action when a transaction starts.

Public method

OnTransactionCommitting

Lets derived classes perform an action when a transaction is being committed.

Public method

OnTransactionRolledBack

Lets derived classes perform an action after a transaction is rolled back.

Public method

OnTransactionRollingBack

Lets derived classes perform an action when a transaction is being rolled back.

Public method

OnViewMouseEnter

Lets derived classes perform an action when the mouse pointer enters the diagram client view.

Public method

OnViewMouseHover

Lets derived classes perform an action when the mouse pointer is over the diagram client view.

Public method

OnViewMouseLeave

Lets derived classes perform an action when the mouse pointer leaves the diagram client view.

Public method

PerformLineRoutingRule

Determines how links between elements appear in the diagram.

Public method

PerformResizeParentRule

Overloaded. Alerts the Domain-Specific Language Designer that a parent shape must be resized to match its child shapes.

Public method

PerformShapeAnchoringRule

Anchors the shape to the diagram. (Inherited from NodeShape.)

Protected method

PermitChildVisibility

Verifies whether the child shape can appear. (Inherited from NodeShape.)

Public method

PostDeserialization

Adjusts the location of shapes on the diagram after the diagram has been deserialized.

Public method

Print

Draws the diagram.

Protected method

ProcessVisibilityChange

Processes a shape's change in visibility. (Inherited from NodeShape.)

Public method

PurgeLayoutObjects

Removes the objects that are used to position the shape on the diagram grid. (Inherited from ShapeElement.)

Public method

PurgePoints

Removes points for the shape on the diagram grid. (Inherited from ShapeElement.)

Public method

RebuildShape

Rebuilds the shape. (Inherited from ShapeElement.)

Public method

RemoveLayoutObject

Removes the shape, including any relative and nested child shapes, from the diagram grid. (Inherited from ShapeElement.)

Public method

Renumber

Renumbers the shapes in the diagram.

Protected method

ReparentSwimlaneChild

Public method

RepositionShapes

Repositions the shapes in the diagram.

Public method

Reroute

Reroutes links between elements on the diagram.

Public method

Selected

Verifies whether the shape is selected in a specified view. (Inherited from ShapeElement.)

Protected method

SetAbsoluteBoundsValue

Sets the absolute bounds for the diagram. (Overrides NodeShape.SetAbsoluteBoundsValue(RectangleD).)

Protected method

SetInitialGraphLayoutVisibility

Sets the visibility of the graph. (Inherited from ShapeElement.)

Protected method

SetIsExpandedValue

Sets the value for the IsExpanded property. (Inherited from NodeShape.)

Public method

SetShowHideState

Sets the visibility of the shape and all its children. (Inherited from ShapeElement.)

Protected method

SetShowHideStateImplementation

Sets the visibility of the shape. (Inherited from ShapeElement.)

Protected method

ShouldAddShapeForElement

Verifies whether a shape can have a child shape assigned to it. (Overrides ShapeElement.ShouldAddShapeForElement(ModelElement).)

Public method

ShouldExcludeFromInvalidationTracking

Verifies whether specific shape types should be excluded from invalidation.

Public method

ShouldReparentOnMove

Verifies whether a child shape should be added to a new parent when the child shape is moved. (Inherited from ShapeElement.)

Public method

ShouldReportException

Verifies whether an exception that is thrown from the base design surface should be reported.

Public method

Show

Makes a shape and all its children visible. (Inherited from ShapeElement.)

Protected method

ShowCustomToolTip

Makes a shape's custom tooltip visible. (Inherited from ShapeElement.)

Public method

Side

Assigns a side of the shape to the port. (Inherited from NodeShape.)

Public method

ToString

Gets the name of the shape and its type. (Inherited from ShapeElement.)

Public method

TranslateGeometryToAbsoluteBounds

Converts the relative bounds to absolute bounds for the shape's geometry. (Inherited from ShapeElement.)

Public method

TranslateGeometryToRelativeBounds

Converts the absolute bounds to relative bounds for the shape's geometry. (Inherited from ShapeElement.)

Public method

TranslateToAbsoluteBounds

Converts the relative bounds to absolute bounds for the shape. (Inherited from ShapeElement.)

Public method

TranslateToRelativeBounds

Converts the absolute bounds to relative bounds for the shape. (Inherited from ShapeElement.)

Public method

UnhandledException

Verifies who should report an exception that is thrown from the base design surface.

Protected method

UpdateChildVisibility

Updates the visibility status for the child shape. (Inherited from NodeShape.)

Protected method

UpdateDerivedVisible

Updates the visible state of the derived shape. (Inherited from ShapeElement.)

Public method

UpdateGeometryLuminosity

Overloaded. Updates the luminosity for the pen or brush.

Top

Explicit Interface Implementations

 

Name

Description

Explicit interface implemetationPrivate method

IMergeElements.CanMerge

(Inherited from ModelElement.)

Public method

ChooseMergeTarget

Overloaded.

Explicit interface implemetationPrivate method

IMergeElements.MergeConfigure

(Inherited from ModelElement.)

Explicit interface implemetationPrivate method

IMergeElements.MergeDisconnect

(Inherited from ModelElement.)

Explicit interface implemetationPrivate method

IMergeElements.MergeRelate

(Inherited from ModelElement.)

Top

See Also

Reference

Diagram Class

Microsoft.VisualStudio.Modeling.Diagrams Namespace