Share via


BinaryLinkShape Class

Represents a line or arrow that can connect two shapes on a diagram. A binary link can also form a loop that connects a shape to itself.

Inheritance Hierarchy

Object
  Microsoft.VisualStudio.Modeling.ModelElement
    Microsoft.VisualStudio.Modeling.Diagrams.PresentationElement
      Microsoft.VisualStudio.Modeling.Diagrams.ShapeElement
        Microsoft.VisualStudio.Modeling.Diagrams.LinkShape
          Microsoft.VisualStudio.Modeling.Diagrams.BinaryLinkShapeBase
            Microsoft.VisualStudio.Modeling.Diagrams.BinaryLinkShape
              Microsoft.VisualStudio.Modeling.Diagrams.GenericLinkShape

Namespace:  Microsoft.VisualStudio.Modeling.Diagrams
Assembly:  Microsoft.VisualStudio.Modeling.Sdk.Diagrams.11.0 (in Microsoft.VisualStudio.Modeling.Sdk.Diagrams.11.0.dll)

Syntax

'Declaration
<CLSCompliantAttribute(True)> _
Public MustInherit Class BinaryLinkShape _
    Inherits BinaryLinkShapeBase
[CLSCompliantAttribute(true)]
public abstract class BinaryLinkShape : BinaryLinkShapeBase
[CLSCompliantAttribute(true)]
public ref class BinaryLinkShape abstract : public BinaryLinkShapeBase
[<AbstractClass>]
[<CLSCompliantAttribute(true)>]
type BinaryLinkShape =  
    class 
        inherit BinaryLinkShapeBase 
    end
public abstract class BinaryLinkShape extends BinaryLinkShapeBase

The BinaryLinkShape type exposes the following members.

Constructors

  Name Description
Protected method BinaryLinkShape Initializes a new instance of the BinaryLinkShape class.

Top

Properties

  Name Description
Public property AbsoluteBoundingBox Gets the bounding rectangle of the link shape relative to the diagram. (Inherited from LinkShape.)
Public property AbsoluteBoundingBoxToEnsureVisible Gets the bounding rectangle that EnsureVisible will use. The rectangle is the same as AbsoluteBoundingBox but with height adjusted to be non-zero when width is non-zero. This is done because for single segment Links, the Height is 0 by default and can cause the selection bounds to return as 'empty' even when a link is truly selected. (Inherited from LinkShape.)
Public property AbsoluteCenter Gets the point in the center of the shape. (Inherited from ShapeElement.)
Public property AccessibilityObject Gets the accessibility object for the shape. (Inherited from ShapeElement.)
Public property AccessibleDefaultActionDescription Gets the default action description for the shape. (Inherited from ShapeElement.)
Public property AccessibleDescription Gets the description for the shape. (Inherited from ShapeElement.)
Public property AccessibleHelp Gets the Help for the shape. (Inherited from ShapeElement.)
Public property AccessibleHelpTopicFileName Gets the Help topic for the shape. (Inherited from ShapeElement.)
Public property AccessibleHelpTopicId Gets the ID of the Help topic for the shape. (Inherited from ShapeElement.)
Public property AccessibleName Returns the name for this shape exposed to accessibility clients. (Inherited from BinaryLinkShapeBase.)
Public property AccessibleRole Gets the role of the shape. (Inherited from ShapeElement.)
Public property AccessibleState Gets the state of the shape. (Inherited from ShapeElement.)
Public property AccessibleValue Gets the value of the shape. (Inherited from ShapeElement.)
Public property AllowsChildrenInSelection If true, the children of this shape can be included in the current selection group. (Inherited from ShapeElement.)
Public property AllowsChildrenToResizeParent true if this shape can be resized when the size or position of a child shape is changed. (Inherited from ShapeElement.)
Public property AllowsChildrenToShrinkParent If true, this shape will reduce in size to fit around its children when they are re-sized or moved. (Inherited from ShapeElement.)
Public property AnchorBothEnds (Inherited from BinaryLinkShapeBase.)
Public property BackgroundBrushId Gets the ID for the brush that is used to paint the background of the shape. (Inherited from ShapeElement.)
Public property BoundingBox Gets the bounding rectangle of the link shape relative to its parent. (Inherited from LinkShape.)
Public property CanFocus Gets the shape and verifies whether it can receive the focus. (Inherited from ShapeElement.)
Public property CanManuallyRoute true if users can manually route the link shape between elements in the diagram; otherwise, false. (Inherited from LinkShape.)
Public property CanMove true if users can reposition the link in the diagram; otherwise, false (Inherited from LinkShape.)
Public property CanMoveAnchorPoints If true, the user can move the endpoints of this LinkShape around the boundaries of the connected shapes. (Inherited from LinkShape.)
Public property CanSelect Gets the shape and verifies whether a user can select it. (Inherited from ShapeElement.)
Public property Center Gets the point in the center of the shape. (Inherited from ShapeElement.)
Protected property ClassStyleSet Gets the style set for the shape. (Inherited from ShapeElement.)
Public property ClipWhenDrawingFields Gets the child shape and verifies whether its clipping region should be set to the bounding box for the parent shape when the child shape is drawn. (Inherited from ShapeElement.)
Public property DecoratorFrom Gets or sets the decorator, such as an arrow, on the From end of the relationship. (Inherited from BinaryLinkShapeBase.)
Public property Decorators Gets the collection of decorators for the shape. (Inherited from ShapeElement.)
Protected property DecoratorsSize (Inherited from BinaryLinkShapeBase.)
Public property DecoratorTo Gets or sets the decorator, such as an arrow, on the To end of the relationship. (Inherited from BinaryLinkShapeBase.)
Protected property DefaultRoutingStyle Gets the default routing style (straight or rectilinear) for the link, set in the DSL Definition. (Inherited from LinkShape.)
Public property DefaultShapeField Gets the default shape, which is the first shape that can receive focus. (Inherited from ShapeElement.)
Public property DefaultSize Gets the default size of the shape. (Inherited from ShapeElement.)
Public property Diagram Gets the diagram to which the shape belongs. (Inherited from ShapeElement.)
Public property EdgePoints The ordered list of points bounding the straight segments of the link shape, including two points at each jumps. (Inherited from LinkShape.)
Public property EdgePointsNoJumps The ordered list of points bounding the straight segments of the link shape. If the link has jumps, their points are not included in the list. (Inherited from LinkShape.)
Public property EndSegmentBreakFactor Gets the length of the link shape and determines how long the last line segment in the link shape must be. (Inherited from LinkShape.)
Public property EnsureVisiblePreference Preferences for the EnsureVisible method for this Shape. Default value is to return the VisiblePreference for the Diagram hosting this Shape. (Inherited from ShapeElement.)
Protected property Events Gets the list of event handlers for the shape. (Inherited from ShapeElement.)
Public property ExcludePath get/set the graphics path This is a singleton on the BinaryLinkShape class. Do not dispose. Use immediately. Use Clone if another path is needed! (Inherited from BinaryLinkShapeBase.)
Public property FixedFrom Indicates whether the user has set the end point manually. (Inherited from BinaryLinkShapeBase.)
Public property FixedTo Indicates whether the user has set the end point manually. (Inherited from BinaryLinkShapeBase.)
Public property FromEndPoint The point where the connector touches the FromShape. (Inherited from BinaryLinkShapeBase.)
Public property FromLinkConnectsToNode Gets the ElementLink relationship that connects the link shape to the node at the From end of the connector. (Inherited from BinaryLinkShapeBase.)
Public property FromShape Gets the NodeShape at the From end of the connector. (Inherited from BinaryLinkShapeBase.)
Public property GeometryBackgroundBrushId Gets the ID of the brush that is used to paint the background of the geometry. (Inherited from ShapeElement.)
Public property GeometryBoundingBox Gets the bounding box of the shape. (Inherited from ShapeElement.)
Public property GeometryCanManuallyRoute Gets a value indicating whether the user is allowed to manually route this LinkShape. (Intended to be called only by the ShapeGeometry-derived classes.) (Inherited from BinaryLinkShapeBase.)
Public property GeometryDecoratorFrom Gets the LinkDecorator at the "from" end of the link. (Intended to be called only by the ShapeGeometry-derived classes.) (Inherited from BinaryLinkShapeBase.)
Public property GeometryDecoratorFromSize Gets the size for the decorator on the From end of the relationship. (Inherited from BinaryLinkShapeBase.)
Public property GeometryDecoratorTo Gets the LinkDecorator at the "to" end of the link. (Intended to be called only by the ShapeGeometry-derived classes.) (Inherited from BinaryLinkShapeBase.)
Public property GeometryDecoratorToSize Gets the size for the decorator on the To end of the relationship. (Inherited from BinaryLinkShapeBase.)
Public property GeometryEdgePoints Gets the edge points in world units (Intended to be called only by the ShapeGeometry-derived classes.) (Inherited from BinaryLinkShapeBase.)
Public property GeometryEdgePointsNoJumps Gets the edge points in world units with no jumps (Intended to be called only by the ShapeGeometry-derived classes.) (Inherited from BinaryLinkShapeBase.)
Public property GeometryHasFilledBackground Gets the shape and verifies whether its background is painted. (Inherited from ShapeElement.)
Public property GeometryHasOutline Gets the shape and verifies whether it has an outline. (Inherited from ShapeElement.)
Public property GeometryHasShadow true if the shape has a shadow; otherwise, false. (Inherited from ShapeElement.)
Public property GeometryOutlinePenId Gets the ID of the pen that draws the outline for the shape. (Inherited from ShapeElement.)
Public property GeometryStyleSet Gets the style set for the shape. (Inherited from ShapeElement.)
Public property GridSize Gets or sets the size of the grid to which the link’s vertices snap. If 0.0, no grid is used. (Inherited from LinkShape.)
Public property HasChildren true if the shape has child shapes. (Inherited from ShapeElement.)
Protected property HasCustomToolTip Gets the shape and verifies whether it has a custom tooltip. (Inherited from ShapeElement.)
Public property HasDragOverToolTip Gets the shape and verifies whether it has a tooltip. (Inherited from ShapeElement.)
Public property HasFilledBackground Gets the shape and verifies whether it has a background. (Inherited from ShapeElement.)
Public property HasHighlighting Gets the shape and verifies whether it is highlighted. (Inherited from ShapeElement.)
Public property HasOutline Gets the shape and verifies whether it has an outline. (Inherited from ShapeElement.)
Public property HasShadow If true, the link is painted with a shadow. (Inherited from LinkShape.)
Public property HasToolTip Gets the shape and verifies whether it has a tooltip. (Inherited from ShapeElement.)
Public property Id Gets the ID of the element. (Inherited from ModelElement.)
Public property IsActive Gets the IsActive flag and verifies to see whether the element is active. (Inherited from ModelElement.)
Public property IsDeleted Gets the IsDeleted flag and checks to see whether the element has been deleted from the model. (Inherited from ModelElement.)
Public property IsDeleting Gets the IsDeleting flag and verifies whether the element is currently being deleted from the model. (Inherited from ModelElement.)
Protected property IsDirected (Inherited from BinaryLinkShapeBase.)
Public property IsNestedChild true if this shape element is in the NestedChildShapes of its ParentShape. (Inherited from ShapeElement.)
Public property IsRelativeChild true if this shape element is in the RelativeChildShapes of its ParentShape. (Inherited from ShapeElement.)
Public property IsVisible If true, the shape appears on the diagram; if false, it does not appear, and layout and routing algorithms ignore it. See also Hide() and Show(). (Inherited from ShapeElement.)
Public property LineAdjustAwayDefault Gets the shape and verifies whether child link shapes should try to align when they are connected to same shape or sets this value. (Inherited from ShapeElement.)
Public property LineAffinityDefault Gets or sets the target location where the link shape should try to position the shape. (Inherited from ShapeElement.)
Public property LineToLineClearance Gets or sets the distance between child link shapes for this shape. (Inherited from ShapeElement.)
Public property LineToNodeClearance Gets or sets the distance between child link shapes and child node shapes. (Inherited from ShapeElement.)
Public property ManuallyRouted True if the user has made a manual change to the routing of this link shape. False if the user has used the Reroute command, or has left the automatic routing unchanged. (Inherited from LinkShape.)
Public property MaximumSize Gets the maximum size for the shape. (Inherited from ShapeElement.)
Public property MinimumSize Gets the minimum size for the shape. (Inherited from ShapeElement.)
Public property ModelElement Gets or sets the model element that is associated with the presentation element. (Inherited from PresentationElement.)
Public property NestedChildShapes The list of shapes that are part of this shape, and are constrained to appear within the boundaries of this shape or diagram. (Inherited from ShapeElement.)
Public property NestedShapesMargin Gets the margin between the shape's bounding box and its nested node shapes. (Inherited from ShapeElement.)
Public property Nodes Gets a list of shapes that are connected to the link shape. (Inherited from LinkShape.)
Public property NodeToNodeClearance Gets or sets the margin between child node shapes. (Inherited from ShapeElement.)
Public property OutlinePenId Gets the ID of the pen that is used to draw the outline of the link shape. (Inherited from LinkShape.)
Public property OutlinePenWidth Gets the width of the outline for the shape. (Inherited from ShapeElement.)
Protected property PaintMoveableDecoratorSelectionLines (Inherited from ShapeElement.)
Protected property ParentLink Gets the relationship instance from the shape to the parent shape. (Inherited from ShapeElement.)
Public property ParentShape Gets the parent shape element. To appear on a diagram, a shape or connector must have a parent. (Inherited from ShapeElement.)
Public property Partition Gets or sets the Partition that contains the element. (Inherited from ModelElement.)
Public property Perimeter Gets the perimeter (path) around the shape. (Inherited from ShapeElement.)
Public property RelatedShapeToEmphasize Gets the related shape to visually emphasize to the user when this shape is selected. (Inherited from ShapeElement.)
Public property RelativeChildShapes The list of shapes that are part of this shape, but can appear outside the boundaries of this shape. (Inherited from ShapeElement.)
Public property RouteJumpType Gets or sets whether the link creates a jump where it crosses another link. (Inherited from LinkShape.)
Public property RoutingStyle Straight (from point to point) or rectilinear (made up of a series of horizontal and vertical segments). (Inherited from LinkShape.)
Public property ShapeFields Parts of a shape such as text rows and decorators. (Inherited from ShapeElement.)
Public property ShapeGeometry Governs how the shape is painted. (Inherited from BinaryLinkShapeBase.)
Public property ShouldTryParentShapeForMergeOnToolboxDoubleClick If true, when the user double-clicks a toolbox item with this shape selected, if the tool cannot be merged with this shape, then a merge with the parent shape will be attempted. Defaults to true. (Inherited from ShapeElement.)
Public property Store Gets the Store that contains the element. (Inherited from ModelElement.)
Public property StyleSet Gets an instance of the style set for the shape. (Inherited from ShapeElement.)
Public property Subject Gets or sets the subject for the presentation element. Defaults to the same object as ModelElement. (Inherited from PresentationElement.)
Protected property TargetRelationshipDomainClassId Gets the ID of the target element that is assigned to the binary link shape.
Public property TargetToolboxItemFilterAttributes Gets a collection of attributes that determine which items are enabled or disabled in the Toolbox. (Inherited from ShapeElement.)
Public property ToEndPoint The point where the connector terminates at the ToShape. (Inherited from BinaryLinkShapeBase.)
Public property ToLinkConnectsToNode Gets the ElementLink relationship that connects the link shape to the node at the To end of the connector. (Inherited from BinaryLinkShapeBase.)
Public property ToShape Gets the NodeShape on the To end of the link shape. (Inherited from BinaryLinkShapeBase.)
Public property UserFixed Gets or sets a fixed line segment. (Inherited from LinkShape.)
Public property ZOrder Determines the order in which this shape will be displayed relative to other shapes on the diagram. Normally set from the order of child shapes. (Inherited from ShapeElement.)

Top

Methods

  Name Description
Public method AccessibleDoDefaultAction Performs the default action for the accessible object. (Inherited from ShapeElement.)
Public method Associate Assigns a model element to the presentation element. The same effect as setting ModelElement. (Inherited from PresentationElement.)
Protected method CalculateDerivedVisible Calculate whether the link shape is visible. True if both end nodes are visible. (Inherited from BinaryLinkShapeBase.)
Protected method CanMerge Verifies whether a source element can be added to this element. (Inherited from ModelElement.)
Protected method ChooseMergeTarget(ElementGroup) Selects a target element to accept as its child an element that the user wants to copy, drag, or create. (Inherited from ModelElement.)
Protected method ChooseMergeTarget(ElementGroupPrototype) Selects a target element to accept as its child an element that the user wants to copy, drag, or create. (Inherited from ModelElement.)
Public method ChooseParentShape Selects a parent shape for a new child shape, typically this shape. (Inherited from ShapeElement.)
Protected method ChooseRelationship Selects which child list a new child shape should be added to – NestedChildShapes or RelativeChildShapes. (Inherited from ShapeElement.)
Public method CoerceSelection Allows a shape to determine which other shapes are selected. (Inherited from ShapeElement.)
Public method Connect Creates the ElementLink relationships needed to connect the specified NodeShape. If this BinaryLinkShape is already on a Diagram, then also connect up the GraphEdge as well. If not, then the GraphEdge is connected up when the BinaryLinkShape is added to a Diagram. (Inherited from BinaryLinkShapeBase.)
Public method Copy() Creates a copy of the element in the model. (Inherited from ModelElement.)
Public method Copy(IEnumerable<Guid>) Creates a copy of the element and its child links and elements. (Inherited from ModelElement.)
Protected method CreateChildShape Creates a shape and adds it as a child to this shape. (Inherited from ShapeElement.)
Protected method CreateClassStyleSet Creates a class style set for the shape type. (Inherited from ShapeElement.)
Protected method CreateDecorators Creates a collection of decorators for the shape type. (Inherited from ShapeElement.)
Protected method CreateInstanceStyleSet Creates a style set for the shape. (Inherited from ShapeElement.)
Protected method CreateShapeFields Creates a collection of shape fields for the shape type. (Inherited from ShapeElement.)
Public method Delete() Deletes an element from the model. (Inherited from ModelElement.)
Public method Delete(array<Guid[]) Deletes an element from the model. (Inherited from ModelElement.)
Protected method DetermineHighlightShape Finds the highlighted shape in a chain of shapes. (Inherited from ShapeElement.)
Public method Disconnect Removes the ElementLink relationships to the NodeShapes at both ends. (Inherited from BinaryLinkShapeBase.)
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(PointD, DiagramHitTestInfo) Returns true if the specified point is within the shape. (Inherited from ShapeElement.)
Public method DoHitTest(PointD, DiagramHitTestInfo, Boolean) Returns true if the specified point is within the shape. (Inherited from ShapeElement.)
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 Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public method ExcludeFromClipRegion Excludes this shape and its endpoint shapes from the clipping region in the specified Graphics object. (Inherited from BinaryLinkShapeBase.)
Public method ExcludeGeometryFromClipRegion Excludes the geometry of a shape and its child shapes from the clipping region. (Inherited from ShapeElement.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method FindDecorator(String) 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 Finds an empty area on the grid for the shape. (Inherited from ShapeElement.)
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 FindShapeField(String) 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 method Focused Verifies whether the shape has the focus. (Inherited from ShapeElement.)
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 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 GetEdgePointsValue Use EdgePoints or EdgePointsNoJumps. (Inherited from LinkShape.)
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.)
Public method GetPotentialMouseAction Gets the mouse action to perform for a mouse down event over a specific point in the diagram. (Inherited from ShapeElement.)
Protected method GetRoleCollection<TCollection, TElement>(Guid) Gets or creates the linked element collection (Inherited from ModelElement.)
Public method GetShapeLuminosity Calculates the luminosity of the shape. (Inherited from ShapeElement.)
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.)
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.)
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.)
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 Initializes the list of fields that represent parts of the shape such as labels, icons, rows of text, and background images. Called once per class. (Inherited from ShapeElement.)
Public method Invalidate() Forces the shape and its immediate to be redrawn on the user’s screen. (Inherited from LinkShape.)
Public method Invalidate(Boolean) Makes sure that the shape will be repainted at the end of the transaction. Call this if you have changed properties of the shape. (Inherited from ShapeElement.)
Public method Invalidate(RectangleD) Makes sure that the shape and its old location will be repainted at the end of the transaction. (Inherited from ShapeElement.)
Public method IsDescendantOf Verifies whether the shape is a descendent of another shape. (Inherited from ShapeElement.)
Protected method IsNavigationKey(Char) Verifies whether the key is used as a navigational command. (Inherited from ShapeElement.)
Protected method IsNavigationKey(Keys) Verifies whether the key data is used as a navigational command. (Inherited from ShapeElement.)
Public method IsRouted True if the link shape has been routed and the EdgePoints are valid, false if the link will be routed later. (Inherited from LinkShape.)
Public method IterateShapes Iterates through a shape and its child shapes. (Inherited from ShapeElement.)
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.)
Protected method MoveByRepositioning(DiagramDragEventArgs) Repositions the shapes in the group by the amount that the position of the mouse determines. (Inherited from ShapeElement.)
Public method MoveByRepositioning(ElementGroupPrototype, DiagramItemCollection, PointD, DiagramItem) Repositions the shapes in the group by the amount that the position of the mouse determines. (Inherited from ShapeElement.)
Public method NavigateAscend Called in response to user’s keystroke navigation to set the focus to the nearest focusable ancestor. (Inherited from LinkShape.)
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 Called in response to user’s keystroke navigation to set the focus on the first child of the parent of the current focus. (Inherited from LinkShape.)
Public method NavigateToLast Called in response to user’s keystroke navigation to set the focus to the last child of the parent of the current focus. (Inherited from LinkShape.)
Public method NavigateToNext Called in response to user’s keystroke navigation to set the focus to the next focusable item in the focus sequence. (Inherited from LinkShape.)
Public method NavigateToPrevious Called in response to user’s keystroke navigation to set the focus to the previous item in the focusing sequence. (Inherited from LinkShape.)
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 OnBeginEdit Called when the user starts to edit a text field. (Inherited from ShapeElement.)
Public method OnBoundsFixup Called when the bounds position and size of the parent and children are set or adjusted. Override to modify the size or internal layout. (Inherited from ShapeElement.)
Protected method OnChildConfigured Called when the positions and sizes of child shapes are about to be determined. Override to set specialized rules. (Inherited from ShapeElement.)
Protected method OnChildConfiguring Called after the size and position of a child shape has been determined. (Inherited from ShapeElement.)
Public method OnClick Called when the user clicks the shape. (Inherited from ShapeElement.)
Protected method OnCopy Called when this element has been created as a copy of another element. (Inherited from ModelElement.)
Protected method OnDeleted Called after the shape is deleted from a diagram. (Inherited from BinaryLinkShapeBase.)
Protected method OnDeleting Called when this element is about to be deleted. (Inherited from ModelElement.)
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 OnEndEdit Called when the user ends editing a text field. (Inherited from ShapeElement.)
Public method OnInitialize Called to initialize the shape. Override this to attach event handlers and rules to this object. (Inherited from ShapeElement.)
Public method OnKeyDown Called when a key is pressed. (Inherited from ShapeElement.)
Public method OnKeyPress Called when a character is typed. (Inherited from ShapeElement.)
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 Called to paint the basic parts of the shape. (Inherited from ShapeElement.)
Protected method OnResurrected Called when this element has been added back to a model. (Inherited from ModelElement.)
Protected method OnRolePlayerPositionChanged Called when the position of a role has changed. (Inherited from ModelElement.)
Protected method OnRolePlayerPositionChanging Called when a role player position is about to change. (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 PerformResizeParentRule() Alerts the Domain-Specific Language Designer that a parent shape must be resized to match its child shapes. (Inherited from ShapeElement.)
Public method PerformResizeParentRule(Boolean, ShapeElement) Alerts the Domain-Specific Language Designer that a parent shape must be resized to match its child shapes. (Inherited from ShapeElement.)
Protected method PermitChildVisibility Verifies whether the child shape should appear in the diagram. (Inherited from ShapeElement.)
Protected method ProcessVisibilityChange Updates the visibility of the child shape when a change to visibility is made. (Inherited from ShapeElement.)
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 RecalculateRoute (Inherited from BinaryLinkShapeBase.)
Public method RemoveLayoutObject Removes the shape, including any relative and nested child shapes, from the diagram grid. (Inherited from ShapeElement.)
Public method Selected Verifies whether the shape is selected in a specified view. (Inherited from ShapeElement.)
Protected method SetDecorators(LinkDecorator, LinkDecorator, Boolean) Set the decorators for the connector. (Inherited from BinaryLinkShapeBase.)
Protected method SetDecorators(LinkDecorator, SizeD, LinkDecorator, SizeD, Boolean) Set the decorators for the connector. (Inherited from BinaryLinkShapeBase.)
Public method SetEdgePointsValue Use EdgePoints property. (Inherited from LinkShape.)
Protected method SetInitialGraphLayoutVisibility Sets the visibility of the graph. (Inherited from ShapeElement.)
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 Determines whether a shape should be created to represent a given domain class instance on the diagram. (Inherited from ShapeElement.)
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 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 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.)
Protected method UpdateDerivedVisible Updates the visible state of the derived shape. (Inherited from ShapeElement.)
Protected method UpdateEdgePoints Updates the edge points for the link shape. (Inherited from LinkShape.)
Public method UpdateGeometryLuminosity(DiagramClientView, Brush) Updates the luminosity for the brush. (Inherited from ShapeElement.)
Public method UpdateGeometryLuminosity(DiagramClientView, Pen) Updates the luminosity for the pen. (Inherited from ShapeElement.)
Public method UpdateGraphEdgePoints Updates the edge points for the link shape and graphs them on the diagram. (Inherited from LinkShape.)

Top

Events

  Name Description
Public event Click Occurs when the user clicks the mouse over a shape. (Inherited from ShapeElement.)
Public event DoubleClick Occurs when the user double-clicks the mouse. (Inherited from ShapeElement.)
Public event KeyDown Occurs when the user presses a key. (Inherited from ShapeElement.)
Public event KeyPress Occurs when the user presses and releases a key. (Inherited from ShapeElement.)
Public event KeyUp Occurs when the user releases a key. (Inherited from ShapeElement.)
Public event MouseDown Occurs when the user presses the mouse button. (Inherited from ShapeElement.)
Public event MouseMove Occurs when the user moves the mouse. (Inherited from ShapeElement.)
Public event MouseUp Occurs when the user releases the mouse button. (Inherited from ShapeElement.)
Public event MouseWheel Occurs when the user rotates the mouse wheel. (Inherited from ShapeElement.)

Top

Extension Methods

  Name Description
Public Extension Method AddExtension(Guid) Overloaded. Extend this ModelElement with newly instantiated extension of the identified domain type. An InvalidOperationException will be thrown if the element already has an extension of that type. (Defined by ModelElementExtensionMethods.)
Public Extension Method AddExtension(Type) Overloaded. Extend this ModelElement with a newly instantiated extension of the specified type. An InvalidOperationException will be thrown if the element already has an extension of that type. (Defined by ModelElementExtensionMethods.)
Public Extension Method AddExtension(DomainClassInfo) Overloaded. Extend this ModelElement with a newly instantiated extension of the specified domain type. An InvalidOperationException will be thrown if the element already has an extension of that type. (Defined by ModelElementExtensionMethods.)
Public Extension Method AddExtension(ExtensionElement) Overloaded. Extend this ModelElement with a specific extension. An InvalidOperationException will be thrown if the element already has an extension of the same type. (Defined by ModelElementExtensionMethods.)
Public Extension Method AddExtension<T>() Overloaded. Extend this ModelElement with a newly instantiated extension of a particular type. An InvalidOperationException will be thrown if the element already has an extension of the same type. (Defined by ModelElementExtensionMethods.)
Public Extension Method CanDelete Deletes the element from the model. (Defined by ImmutabilityExtensionMethods.)
Public Extension Method GetAllExtensions Return an enumerable that performs a breadth first traversal across the tree of extension elements embedded in this ModelElement. (Defined by ModelElementExtensionMethods.)
Public Extension Method GetBaseElement Returns the root of the virtual MEL in which the specified ModelElement is participating. (Defined by ModelElementExtensionMethods.)
Public Extension Method GetDslDefinitionModelElement This method guarantees that the real model element corresponding to the PresentationElement is returned. For DslDesigner PELs, the corresponding subject may actually be an internal TreeNode class and not the actual MEL. This method handles those cases correctly so that the actual MEL is returned. (Defined by PresentationElementHelper.)
Public Extension Method GetExtension(Guid) Overloaded. (Defined by ModelElementExtensionMethods.)
Public Extension Method GetExtension(Type) Overloaded. Get the ExtensionElement of the specified type from the available extensions of this ModelElement. If the element has no such extension then an InvalidOperationException will be raised. (Defined by ModelElementExtensionMethods.)
Public Extension Method GetExtension(DomainClassInfo) Overloaded. (Defined by ModelElementExtensionMethods.)
Public Extension Method GetExtension<T>() Overloaded. Get the ExtensionElement of the specified type from the available extensions of this ModelElement. If the element has no such extension then an InvalidOperationException will be raised. (Defined by ModelElementExtensionMethods.)
Public Extension Method GetLocks Get the lock flags for this element. This will include any locks enabled on the Partition containing the element. (Defined by ImmutabilityExtensionMethods.)
Public Extension Method IsExtendedBy(Guid) Overloaded. Query whether this ModelElement is currently extended by an ExtensionElement of a particular type. (Defined by ModelElementExtensionMethods.)
Public Extension Method IsExtendedBy(Type) Overloaded. Query whether this ModelElement is currently extended by an ExtensionElement of a particular type. (Defined by ModelElementExtensionMethods.)
Public Extension Method IsExtendedBy(DomainClassInfo) Overloaded. Query whether this ModelElement is currently extended by an ExtensionElement of a particular type. (Defined by ModelElementExtensionMethods.)
Public Extension Method IsLocked Test whether this element has any of a specified set of locks (Defined by ImmutabilityExtensionMethods.)
Public Extension Method RemoveExtension(Type) Overloaded. Remove any extension of this ModelElement that is of a particular type. (Defined by ModelElementExtensionMethods.)
Public Extension Method RemoveExtension(Guid) Overloaded. Remove any extension of the specified ModelElement that is of a particular type. (Defined by ModelElementExtensionMethods.)
Public Extension Method RemoveExtension(DomainClassInfo) Overloaded. Remove any extension of the specified ModelElement that is of a particular type. (Defined by ModelElementExtensionMethods.)
Public Extension Method RemoveExtension(ExtensionElement) Overloaded. Remove a specified ExtensionElement from the extensions of this ModelElement. (Defined by ModelElementExtensionMethods.)
Public Extension Method SetLocks Set the lock flags of this element (Defined by ImmutabilityExtensionMethods.)
Public Extension Method TryGetExtension(Guid) Overloaded. (Defined by ModelElementExtensionMethods.)
Public Extension Method TryGetExtension(Type) Overloaded. (Defined by ModelElementExtensionMethods.)
Public Extension Method TryGetExtension(DomainClassInfo) Overloaded. (Defined by ModelElementExtensionMethods.)
Public Extension Method TryGetExtension<T>() Overloaded. Get the ExtensionElement of the specified type from the available extensions of this ModelElement. If this element has no such extension then the result will be null. (Defined by ModelElementExtensionMethods.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IMergeElements.CanMerge Returns true if this element can merge with the content of the prototype. (Inherited from ModelElement.)
Explicit interface implemetationPrivate method IMergeElements.ChooseMergeTarget(ElementGroup) (Inherited from ModelElement.)
Explicit interface implemetationPrivate method IMergeElements.ChooseMergeTarget(ElementGroupPrototype) (Inherited from ModelElement.)
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

Remarks

BinaryLinkShape is the class from which all connector shapes derive. When you define a connector class in the DSL Definition, its default base class is BinaryLinkShape, unless you explicitly specify another connector class as the base.

A BinaryLinkShape is usually the graphical representation of an instance of a domain relationship. The domain relationship represents conceptual information, and the link shape or connector represents its visible appearance on the diagram. In the DSL Definition, you define a Diagram Element Map between the connector class and the domain relationship. At run time, you can access the domain relationship instance by using the property ModelElement. To navigate from one element to another, it is usually better to navigate first to the model element and then traverse the domain relationships, instead of traversing connectors on the diagram.

For more information and examples, see [redirect] How to: Navigate and Update a Diagram.

Warning

Most of the methods of this type are defined in BinaryLinkShapeBase.

Examples

For examples, see [redirect] How to: Navigate and Update a Diagram.

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.

See Also

Reference

Microsoft.VisualStudio.Modeling.Diagrams Namespace

NodeShape

BinaryLinkShapeBase

Other Resources

[redirect] How to: Navigate and Update a Diagram

How to Define a Domain-Specific Language