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.

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

[CLSCompliantAttribute(true)]
public abstract class BinaryLinkShape : BinaryLinkShapeBase

The BinaryLinkShape type exposes the following members.

  NameDescription
Protected methodBinaryLinkShapeInitializes a new instance of the BinaryLinkShape class.
Top

  NameDescription
Public propertyAbsoluteBoundingBoxGets the bounding rectangle of the link shape relative to the diagram. (Inherited from LinkShape.)
Public propertyAbsoluteBoundingBoxToEnsureVisibleGets 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 propertyAbsoluteCenterGets the point in the center of the shape. (Inherited from ShapeElement.)
Public propertyAccessibilityObjectGets the accessibility object for the shape. (Inherited from ShapeElement.)
Public propertyAccessibleDefaultActionDescriptionGets the default action description for the shape. (Inherited from ShapeElement.)
Public propertyAccessibleDescriptionGets the description for the shape. (Inherited from ShapeElement.)
Public propertyAccessibleHelpGets the Help for the shape. (Inherited from ShapeElement.)
Public propertyAccessibleHelpTopicFileNameGets the Help topic for the shape. (Inherited from ShapeElement.)
Public propertyAccessibleHelpTopicIdGets the ID of the Help topic for the shape. (Inherited from ShapeElement.)
Public propertyAccessibleNameReturns the name for this shape exposed to accessibility clients. (Inherited from BinaryLinkShapeBase.)
Public propertyAccessibleRoleGets the role of the shape. (Inherited from ShapeElement.)
Public propertyAccessibleStateGets the state of the shape. (Inherited from ShapeElement.)
Public propertyAccessibleValueGets the value of the shape. (Inherited from ShapeElement.)
Public propertyAllowsChildrenInSelectionIf true, the children of this shape can be included in the current selection group. (Inherited from ShapeElement.)
Public propertyAllowsChildrenToResizeParenttrue if this shape can be resized when the size or position of a child shape is changed. (Inherited from ShapeElement.)
Public propertyAllowsChildrenToShrinkParentIf true, this shape will reduce in size to fit around its children when they are re-sized or moved. (Inherited from ShapeElement.)
Public propertyAnchorBothEnds (Inherited from BinaryLinkShapeBase.)
Public propertyBackgroundBrushIdGets the ID for the brush that is used to paint the background of the shape. (Inherited from ShapeElement.)
Public propertyBoundingBoxGets the bounding rectangle of the link shape relative to its parent. (Inherited from LinkShape.)
Public propertyCanFocusGets the shape and verifies whether it can receive the focus. (Inherited from ShapeElement.)
Public propertyCanManuallyRoutetrue if users can manually route the link shape between elements in the diagram; otherwise, false. (Inherited from LinkShape.)
Public propertyCanMovetrue if users can reposition the link in the diagram; otherwise, false (Inherited from LinkShape.)
Public propertyCanMoveAnchorPointsIf true, the user can move the endpoints of this LinkShape around the boundaries of the connected shapes. (Inherited from LinkShape.)
Public propertyCanSelectGets the shape and verifies whether a user can select it. (Inherited from ShapeElement.)
Public propertyCenterGets the point in the center of the shape. (Inherited from ShapeElement.)
Protected propertyClassStyleSetGets the style set for the shape. (Inherited from ShapeElement.)
Public propertyClipWhenDrawingFieldsGets 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 propertyDecoratorFromGets or sets the decorator, such as an arrow, on the From end of the relationship. (Inherited from BinaryLinkShapeBase.)
Public propertyDecoratorsGets the collection of decorators for the shape. (Inherited from ShapeElement.)
Protected propertyDecoratorsSize (Inherited from BinaryLinkShapeBase.)
Public propertyDecoratorToGets or sets the decorator, such as an arrow, on the To end of the relationship. (Inherited from BinaryLinkShapeBase.)
Protected propertyDefaultRoutingStyleGets the default routing style (straight or rectilinear) for the link, set in the DSL Definition. (Inherited from LinkShape.)
Public propertyDefaultShapeFieldGets the default shape, which is the first shape that can receive focus. (Inherited from ShapeElement.)
Public propertyDefaultSizeGets the default size of the shape. (Inherited from ShapeElement.)
Public propertyDiagramGets the diagram to which the shape belongs. (Inherited from ShapeElement.)
Public propertyEdgePointsThe ordered list of points bounding the straight segments of the link shape, including two points at each jumps. (Inherited from LinkShape.)
Public propertyEdgePointsNoJumpsThe 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 propertyEndSegmentBreakFactorGets the length of the link shape and determines how long the last line segment in the link shape must be. (Inherited from LinkShape.)
Public propertyEnsureVisiblePreferencePreferences for the EnsureVisible method for this Shape. Default value is to return the VisiblePreference for the Diagram hosting this Shape. (Inherited from ShapeElement.)
Protected propertyEventsGets the list of event handlers for the shape. (Inherited from ShapeElement.)
Public propertyExcludePathget/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 propertyFixedFromIndicates whether the user has set the end point manually. (Inherited from BinaryLinkShapeBase.)
Public propertyFixedToIndicates whether the user has set the end point manually. (Inherited from BinaryLinkShapeBase.)
Public propertyFromEndPointThe point where the connector touches the FromShape. (Inherited from BinaryLinkShapeBase.)
Public propertyFromLinkConnectsToNodeGets the ElementLink relationship that connects the link shape to the node at the From end of the connector. (Inherited from BinaryLinkShapeBase.)
Public propertyFromShapeGets the NodeShape at the From end of the connector. (Inherited from BinaryLinkShapeBase.)
Public propertyGeometryBackgroundBrushIdGets the ID of the brush that is used to paint the background of the geometry. (Inherited from ShapeElement.)
Public propertyGeometryBoundingBoxGets the bounding box of the shape. (Inherited from ShapeElement.)
Public propertyGeometryCanManuallyRouteGets 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 propertyGeometryDecoratorFromGets the LinkDecorator at the "from" end of the link. (Intended to be called only by the ShapeGeometry-derived classes.) (Inherited from BinaryLinkShapeBase.)
Public propertyGeometryDecoratorFromSizeGets the size for the decorator on the From end of the relationship. (Inherited from BinaryLinkShapeBase.)
Public propertyGeometryDecoratorToGets the LinkDecorator at the "to" end of the link. (Intended to be called only by the ShapeGeometry-derived classes.) (Inherited from BinaryLinkShapeBase.)
Public propertyGeometryDecoratorToSizeGets the size for the decorator on the To end of the relationship. (Inherited from BinaryLinkShapeBase.)
Public propertyGeometryEdgePointsGets the edge points in world units (Intended to be called only by the ShapeGeometry-derived classes.) (Inherited from BinaryLinkShapeBase.)
Public propertyGeometryEdgePointsNoJumpsGets the edge points in world units with no jumps (Intended to be called only by the ShapeGeometry-derived classes.) (Inherited from BinaryLinkShapeBase.)
Public propertyGeometryHasFilledBackgroundGets the shape and verifies whether its background is painted. (Inherited from ShapeElement.)
Public propertyGeometryHasOutlineGets the shape and verifies whether it has an outline. (Inherited from ShapeElement.)
Public propertyGeometryHasShadowtrue if the shape has a shadow; otherwise, false. (Inherited from ShapeElement.)
Public propertyGeometryOutlinePenIdGets the ID of the pen that draws the outline for the shape. (Inherited from ShapeElement.)
Public propertyGeometryStyleSetGets the style set for the shape. (Inherited from ShapeElement.)
Public propertyGridSizeGets 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 propertyHasChildrentrue if the shape has child shapes. (Inherited from ShapeElement.)
Protected propertyHasCustomToolTipGets the shape and verifies whether it has a custom tooltip. (Inherited from ShapeElement.)
Public propertyHasDragOverToolTipGets the shape and verifies whether it has a tooltip. (Inherited from ShapeElement.)
Public propertyHasFilledBackgroundGets the shape and verifies whether it has a background. (Inherited from ShapeElement.)
Public propertyHasHighlightingGets the shape and verifies whether it is highlighted. (Inherited from ShapeElement.)
Public propertyHasOutlineGets the shape and verifies whether it has an outline. (Inherited from ShapeElement.)
Public propertyHasShadowIf true, the link is painted with a shadow. (Inherited from LinkShape.)
Public propertyHasToolTipGets the shape and verifies whether it has a tooltip. (Inherited from ShapeElement.)
Public propertyIdGets the ID of the element. (Inherited from ModelElement.)
Public propertyIsActiveGets the IsActive flag and verifies to see whether the element is active. (Inherited from ModelElement.)
Public propertyIsDeletedGets the IsDeleted flag and checks to see whether the element has been deleted from the model. (Inherited from ModelElement.)
Public propertyIsDeletingGets the IsDeleting flag and verifies whether the element is currently being deleted from the model. (Inherited from ModelElement.)
Protected propertyIsDirected (Inherited from BinaryLinkShapeBase.)
Public propertyIsNestedChildtrue if this shape element is in the NestedChildShapes of its ParentShape. (Inherited from ShapeElement.)
Public propertyIsRelativeChildtrue if this shape element is in the RelativeChildShapes of its ParentShape. (Inherited from ShapeElement.)
Public propertyIsVisibleIf 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 propertyLineAdjustAwayDefaultGets 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 propertyLineAffinityDefaultGets or sets the target location where the link shape should try to position the shape. (Inherited from ShapeElement.)
Public propertyLineToLineClearanceGets or sets the distance between child link shapes for this shape. (Inherited from ShapeElement.)
Public propertyLineToNodeClearanceGets or sets the distance between child link shapes and child node shapes. (Inherited from ShapeElement.)
Public propertyManuallyRoutedTrue 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 propertyMaximumSizeGets the maximum size for the shape. (Inherited from ShapeElement.)
Public propertyMinimumSizeGets the minimum size for the shape. (Inherited from ShapeElement.)
Public propertyModelElementGets or sets the model element that is associated with the presentation element. (Inherited from PresentationElement.)
Public propertyNestedChildShapesThe 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 propertyNestedShapesMarginGets the margin between the shape's bounding box and its nested node shapes. (Inherited from ShapeElement.)
Public propertyNodesGets a list of shapes that are connected to the link shape. (Inherited from LinkShape.)
Public propertyNodeToNodeClearanceGets or sets the margin between child node shapes. (Inherited from ShapeElement.)
Public propertyOutlinePenIdGets the ID of the pen that is used to draw the outline of the link shape. (Inherited from LinkShape.)
Public propertyOutlinePenWidthGets the width of the outline for the shape. (Inherited from ShapeElement.)
Protected propertyPaintMoveableDecoratorSelectionLines (Inherited from ShapeElement.)
Protected propertyParentLinkGets the relationship instance from the shape to the parent shape. (Inherited from ShapeElement.)
Public propertyParentShapeGets the parent shape element. To appear on a diagram, a shape or connector must have a parent. (Inherited from ShapeElement.)
Public propertyPartitionGets or sets the Partition that contains the element. (Inherited from ModelElement.)
Public propertyPerimeterGets the perimeter (path) around the shape. (Inherited from ShapeElement.)
Public propertyRelatedShapeToEmphasizeGets the related shape to visually emphasize to the user when this shape is selected. (Inherited from ShapeElement.)
Public propertyRelativeChildShapesThe list of shapes that are part of this shape, but can appear outside the boundaries of this shape. (Inherited from ShapeElement.)
Public propertyRouteJumpTypeGets or sets whether the link creates a jump where it crosses another link. (Inherited from LinkShape.)
Public propertyRoutingStyleStraight (from point to point) or rectilinear (made up of a series of horizontal and vertical segments). (Inherited from LinkShape.)
Public propertyShapeFieldsParts of a shape such as text rows and decorators. (Inherited from ShapeElement.)
Public propertyShapeGeometryGoverns how the shape is painted. (Inherited from BinaryLinkShapeBase.)
Public propertyShouldTryParentShapeForMergeOnToolboxDoubleClickIf 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 propertyStoreGets the Store that contains the element. (Inherited from ModelElement.)
Public propertyStyleSetGets an instance of the style set for the shape. (Inherited from ShapeElement.)
Public propertySubjectGets or sets the subject for the presentation element. Defaults to the same object as ModelElement. (Inherited from PresentationElement.)
Protected propertyTargetRelationshipDomainClassIdGets the ID of the target element that is assigned to the binary link shape.
Public propertyTargetToolboxItemFilterAttributesGets a collection of attributes that determine which items are enabled or disabled in the Toolbox. (Inherited from ShapeElement.)
Public propertyToEndPointThe point where the connector terminates at the ToShape. (Inherited from BinaryLinkShapeBase.)
Public propertyToLinkConnectsToNodeGets the ElementLink relationship that connects the link shape to the node at the To end of the connector. (Inherited from BinaryLinkShapeBase.)
Public propertyToShapeGets the NodeShape on the To end of the link shape. (Inherited from BinaryLinkShapeBase.)
Public propertyUserFixedGets or sets a fixed line segment. (Inherited from LinkShape.)
Public propertyZOrderDetermines 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

  NameDescription
Public methodAccessibleDoDefaultActionPerforms the default action for the accessible object. (Inherited from ShapeElement.)
Public methodAssociateAssigns a model element to the presentation element. The same effect as setting ModelElement. (Inherited from PresentationElement.)
Protected methodCalculateDerivedVisibleCalculate whether the link shape is visible. True if both end nodes are visible. (Inherited from BinaryLinkShapeBase.)
Protected methodCanMergeVerifies whether a source element can be added to this element. (Inherited from ModelElement.)
Protected methodChooseMergeTarget(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 methodChooseMergeTarget(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 methodChooseParentShapeSelects a parent shape for a new child shape, typically this shape. (Inherited from ShapeElement.)
Protected methodChooseRelationshipSelects which child list a new child shape should be added to – NestedChildShapes or RelativeChildShapes. (Inherited from ShapeElement.)
Public methodCoerceSelectionAllows a shape to determine which other shapes are selected. (Inherited from ShapeElement.)
Public methodConnectCreates 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 methodCopy()Creates a copy of the element in the model. (Inherited from ModelElement.)
Public methodCopy(IEnumerable<Guid>)Creates a copy of the element and its child links and elements. (Inherited from ModelElement.)
Protected methodCreateChildShapeCreates a shape and adds it as a child to this shape. (Inherited from ShapeElement.)
Protected methodCreateClassStyleSetCreates a class style set for the shape type. (Inherited from ShapeElement.)
Protected methodCreateDecoratorsCreates a collection of decorators for the shape type. (Inherited from ShapeElement.)
Protected methodCreateInstanceStyleSetCreates a style set for the shape. (Inherited from ShapeElement.)
Protected methodCreateShapeFieldsCreates a collection of shape fields for the shape type. (Inherited from ShapeElement.)
Public methodDelete()Deletes an element from the model. (Inherited from ModelElement.)
Public methodDelete(Guid[])Deletes an element from the model. (Inherited from ModelElement.)
Protected methodDetermineHighlightShapeFinds the highlighted shape in a chain of shapes. (Inherited from ShapeElement.)
Public methodDisconnectRemoves the ElementLink relationships to the NodeShapes at both ends. (Inherited from BinaryLinkShapeBase.)
Public methodDoFoldToShapeCalculates 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 methodDoHitTest(PointD, DiagramHitTestInfo)Returns true if the specified point is within the shape. (Inherited from ShapeElement.)
Public methodDoHitTest(PointD, DiagramHitTestInfo, Boolean)Returns true if the specified point is within the shape. (Inherited from ShapeElement.)
Public methodDoHitTestSelectionReturns true if a given point is in the selection handles around the shape. (Inherited from ShapeElement.)
Public methodDoKeyboardNavigationNavigates the from shape to shape, using the keyboard. (Inherited from ShapeElement.)
Public methodDrawResizeFeedbackDraws the resizing feedback for the shape. (Inherited from ShapeElement.)
Public methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodExcludeFromClipRegionExcludes this shape and its endpoint shapes from the clipping region in the specified Graphics object. (Inherited from BinaryLinkShapeBase.)
Public methodExcludeGeometryFromClipRegionExcludes the geometry of a shape and its child shapes from the clipping region. (Inherited from ShapeElement.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodFindDecorator(String)Finds the shape decorator that has a given name. (Inherited from ShapeElement.)
Public methodFindFirstChildSearches for the first child in the navigation sequence for the shape. (Inherited from ShapeElement.)
Public methodFindFreeAreaFinds an empty area on the grid for the shape. (Inherited from ShapeElement.)
Public methodFindLastChildSearches for the last child in the navigation sequence for the shape. (Inherited from ShapeElement.)
Public methodFindNextChildSearches for the next child in the navigation sequence for the shape. (Inherited from ShapeElement.)
Public methodFindNextInChildFieldsSearches for the next shape field in the navigation sequence. (Inherited from ShapeElement.)
Public methodFindPreviousChildSearches for the previous child in the navigation sequence for the shape. (Inherited from ShapeElement.)
Public methodFindPreviousInChildFieldsSearches for the previous shape field in the navigation sequence. (Inherited from ShapeElement.)
Public methodFindShapeField(String)Searches for a shape field in a shape. (Inherited from ShapeElement.)
Public methodFixUpChildShapesCreates 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 methodFocusedVerifies whether the shape has the focus. (Inherited from ShapeElement.)
Public methodGetAccessibilityObjectGets the accessible object that is assigned to the shape. (Inherited from ShapeElement.)
Public methodGetChildElementsGets a collection of child shapes that belong to the parent shape. (Inherited from ShapeElement.)
Public methodGetCursorGets the pointer that appears when the mouse is over the shape. (Inherited from ShapeElement.)
Public methodGetDomainClassGets the most-derived domain class for this element. (Inherited from ModelElement.)
Public methodGetDragOverToolTipTextGets the tooltip text that appears when the mouse is over the shape. (Inherited from ShapeElement.)
Public methodGetEdgePointsValueUse EdgePoints or EdgePointsNoJumps. (Inherited from LinkShape.)
Public methodGetFieldAccessibleDescriptionGets the description for a field in the shape. (Inherited from ShapeElement.)
Public methodGetFieldAccessibleNameGets the name of a field in the shape. (Inherited from ShapeElement.)
Public methodGetFieldAccessibleValueGets the value for a field in the shape. (Inherited from ShapeElement.)
Public methodGetFieldRepresentedElementGets the primary element that the child shape represents. (Inherited from ShapeElement.)
Public methodGetFieldRepresentedPropertyGets the property information for a field in the shape. (Inherited from ShapeElement.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetPotentialMouseActionGets the mouse action to perform for a mouse down event over a specific point in the diagram. (Inherited from ShapeElement.)
Protected methodGetRoleCollection<TCollection, TElement>(Guid)Gets or creates the linked element collection (Inherited from ModelElement.)
Public methodGetShapeLuminosityCalculates the luminosity of the shape. (Inherited from ShapeElement.)
Public methodGetSubFieldAccessibleDescriptionGets the description for a child field in the shape. (Inherited from ShapeElement.)
Public methodGetSubFieldAccessibleNameGets the name of a child field in the shape. (Inherited from ShapeElement.)
Public methodGetSubFieldAccessibleValueGets the value for a child field in the shape. (Inherited from ShapeElement.)
Public methodGetSubFieldRepresentedElementsGets a collection of elements that the shape for the child field represents. (Inherited from ShapeElement.)
Public methodGetSubFieldRepresentedPropertyGets the property for the child field. (Inherited from ShapeElement.)
Public methodGetSubFieldRepresentedPropertyElementsGets the element that contains the property for the child field. (Inherited from ShapeElement.)
Public methodGetToolTipTextGets the tooltip text for the shape to which the mouse is pointing. (Inherited from ShapeElement.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodHasCachedDragOverResultVerifies whether the results are cached for the drag-over mouse event. (Inherited from ShapeElement.)
Public methodHideHides the shape and all its children. (Inherited from ShapeElement.)
Protected methodHideCustomToolTipHides the custom tooltip for the shape. (Inherited from ShapeElement.)
Protected methodInitializeDecoratorsInitializes and adds fields to the shape type. (Inherited from ShapeElement.)
Protected methodInitializeInstanceResourcesInitializes the resources for an instance of the shape. (Inherited from ShapeElement.)
Protected methodInitializeResourcesInitializes the resources for the shape. (Inherited from ShapeElement.)
Protected methodInitializeShapeFieldsInitializes 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 methodInvalidate()Forces the shape and its immediate to be redrawn on the user’s screen. (Inherited from LinkShape.)
Public methodInvalidate(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 methodInvalidate(RectangleD)Makes sure that the shape and its old location will be repainted at the end of the transaction. (Inherited from ShapeElement.)
Public methodIsDescendantOfVerifies whether the shape is a descendent of another shape. (Inherited from ShapeElement.)
Protected methodIsNavigationKey(Char)Verifies whether the key is used as a navigational command. (Inherited from ShapeElement.)
Protected methodIsNavigationKey(Keys)Verifies whether the key data is used as a navigational command. (Inherited from ShapeElement.)
Public methodIsRoutedTrue if the link shape has been routed and the EdgePoints are valid, false if the link will be routed later. (Inherited from LinkShape.)
Public methodIterateShapesIterates through a shape and its child shapes. (Inherited from ShapeElement.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodMergeConfigureNot used for presentation elements. (Inherited from PresentationElement.)
Protected methodMergeDisconnectDisconnects a source element from a target element. (Inherited from ModelElement.)
Protected methodMergeRelateCreates a relationship between a model element and a group of model elements. (Inherited from PresentationElement.)
Protected methodModifyLuminosityCalculates the luminosity of the highlight for the shape. (Inherited from ShapeElement.)
Protected methodMoveByRepositioning(DiagramDragEventArgs)Repositions the shapes in the group by the amount that the position of the mouse determines. (Inherited from ShapeElement.)
Public methodMoveByRepositioning(ElementGroupPrototype, DiagramItemCollection, PointD, DiagramItem)Repositions the shapes in the group by the amount that the position of the mouse determines. (Inherited from ShapeElement.)
Public methodNavigateAscendCalled in response to user’s keystroke navigation to set the focus to the nearest focusable ancestor. (Inherited from LinkShape.)
Public methodNavigateDescendNavigates to the next descendent in the navigation sequence and updates the focus. Called in response to user navigation keystrokes. (Inherited from ShapeElement.)
Protected methodNavigateToNavigates to a specific shape in the navigation sequence and updates the focus. (Inherited from ShapeElement.)
Public methodNavigateToFirstCalled 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 methodNavigateToLastCalled 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 methodNavigateToNextCalled in response to user’s keystroke navigation to set the focus to the next focusable item in the focus sequence. (Inherited from LinkShape.)
Public methodNavigateToPreviousCalled in response to user’s keystroke navigation to set the focus to the previous item in the focusing sequence. (Inherited from LinkShape.)
Protected methodOnAssociatedPropertyChangedUpdates the shape when the value of an in-memory store property changes for a field in the shape. (Inherited from ShapeElement.)
Protected methodOnBeforePaintUpdates resources, such as pens and brushes, before they are used to paint the shape. (Inherited from ShapeElement.)
Public methodOnBeginEditCalled when the user starts to edit a text field. (Inherited from ShapeElement.)
Public methodOnBoundsFixupCalled 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 methodOnChildConfiguredCalled when the positions and sizes of child shapes are about to be determined. Override to set specialized rules. (Inherited from ShapeElement.)
Protected methodOnChildConfiguringCalled after the size and position of a child shape has been determined. (Inherited from ShapeElement.)
Public methodOnClickCalled when the user clicks the shape. (Inherited from ShapeElement.)
Protected methodOnCopyCalled when this element has been created as a copy of another element. (Inherited from ModelElement.)
Protected methodOnDeletedCalled after the shape is deleted from a diagram. (Inherited from BinaryLinkShapeBase.)
Protected methodOnDeletingCalled when this element is about to be deleted. (Inherited from ModelElement.)
Public methodOnDoubleClickCalled when the user double-clicks the shape. (Inherited from ShapeElement.)
Public methodOnDragDropCalled when the user drags an item onto the shape. (Inherited from ShapeElement.)
Public methodOnDragEnterCalled when the mouse enters a shape during a drag operation. (Inherited from ShapeElement.)
Public methodOnDragLeaveCalled when the mouse moves out of a shape. (Inherited from ShapeElement.)
Public methodOnDragOverOverride 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 methodOnEndEditCalled when the user ends editing a text field. (Inherited from ShapeElement.)
Public methodOnInitializeCalled to initialize the shape. Override this to attach event handlers and rules to this object. (Inherited from ShapeElement.)
Public methodOnKeyDownCalled when a key is pressed. (Inherited from ShapeElement.)
Public methodOnKeyPressCalled when a character is typed. (Inherited from ShapeElement.)
Public methodOnKeyUpCalled when a key is released. (Inherited from ShapeElement.)
Public methodOnMouseDownCalled when the user presses a mouse key. (Inherited from ShapeElement.)
Public methodOnMouseEnterCalled when the mouse enters a shape. (Inherited from ShapeElement.)
Public methodOnMouseHoverCalled when the mouse hovers over a shape. (Inherited from ShapeElement.)
Public methodOnMouseLeaveCalled when the mouse leaves a shape. (Inherited from ShapeElement.)
Public methodOnMouseMoveCalled repeatedly when the user moves the mouse. (Inherited from ShapeElement.)
Public methodOnMouseUpCalled when a mouse button is released. (Inherited from ShapeElement.)
Public methodOnMouseWheelCalled when the user has rotated the mouse wheel. (Inherited from ShapeElement.)
Public methodOnOrphanedCalled when a (Inherited from ShapeElement.)
Public methodOnPaintEmphasisCalled when emphasis has been applied to the selected shape. (Inherited from ShapeElement.)
Public methodOnPaintFeedbackCalled when drag-and-drop feedback is painted. (Inherited from ShapeElement.)
Public methodOnPaintSelectionCalled to paint the selection highlight. (Inherited from ShapeElement.)
Public methodOnPaintShapeCalled to paint the basic parts of the shape. (Inherited from ShapeElement.)
Protected methodOnResurrectedCalled when this element has been added back to a model. (Inherited from ModelElement.)
Protected methodOnRolePlayerPositionChangedCalled when the position of a role has changed. (Inherited from ModelElement.)
Protected methodOnRolePlayerPositionChangingCalled when a role player position is about to change. (Inherited from ModelElement.)
Public methodOnShapeInsertedCalled when a shape has been inserted as a child of another. (Inherited from ShapeElement.)
Public methodOnShapeRemovedCalled when the shape has been removed as a child shape from its parent shape. (Inherited from ShapeElement.)
Public methodPerformResizeParentRule()Alerts the Domain-Specific Language Designer that a parent shape must be resized to match its child shapes. (Inherited from ShapeElement.)
Public methodPerformResizeParentRule(Boolean, ShapeElement)Alerts the Domain-Specific Language Designer that a parent shape must be resized to match its child shapes. (Inherited from ShapeElement.)
Protected methodPermitChildVisibilityVerifies whether the child shape should appear in the diagram. (Inherited from ShapeElement.)
Protected methodProcessVisibilityChangeUpdates the visibility of the child shape when a change to visibility is made. (Inherited from ShapeElement.)
Public methodPurgeLayoutObjectsRemoves the objects that are used to position the shape on the diagram grid. (Inherited from ShapeElement.)
Public methodPurgePointsRemoves points for the shape on the diagram grid. (Inherited from ShapeElement.)
Public methodRebuildShapeRebuilds the shape. (Inherited from ShapeElement.)
Public methodRecalculateRoute (Inherited from BinaryLinkShapeBase.)
Public methodRemoveLayoutObjectRemoves the shape, including any relative and nested child shapes, from the diagram grid. (Inherited from ShapeElement.)
Public methodSelectedVerifies whether the shape is selected in a specified view. (Inherited from ShapeElement.)
Protected methodSetDecorators(LinkDecorator, LinkDecorator, Boolean)Set the decorators for the connector. (Inherited from BinaryLinkShapeBase.)
Protected methodSetDecorators(LinkDecorator, SizeD, LinkDecorator, SizeD, Boolean)Set the decorators for the connector. (Inherited from BinaryLinkShapeBase.)
Public methodSetEdgePointsValueUse EdgePoints property. (Inherited from LinkShape.)
Protected methodSetInitialGraphLayoutVisibilitySets the visibility of the graph. (Inherited from ShapeElement.)
Public methodSetShowHideStateSets the visibility of the shape and all its children. (Inherited from ShapeElement.)
Protected methodSetShowHideStateImplementationSets the visibility of the shape. (Inherited from ShapeElement.)
Protected methodShouldAddShapeForElementDetermines whether a shape should be created to represent a given domain class instance on the diagram. (Inherited from ShapeElement.)
Public methodShouldReparentOnMoveVerifies whether a child shape should be added to a new parent when the child shape is moved. (Inherited from ShapeElement.)
Public methodShowMakes a shape and all its children visible. (Inherited from ShapeElement.)
Protected methodShowCustomToolTipMakes a shape's custom tooltip visible. (Inherited from ShapeElement.)
Public methodToStringGets the name of the shape and its type. (Inherited from ShapeElement.)
Public methodTranslateGeometryToAbsoluteBoundsConverts the relative bounds to absolute bounds for the shape's geometry. (Inherited from ShapeElement.)
Public methodTranslateGeometryToRelativeBoundsConverts the absolute bounds to relative bounds for the shape's geometry. (Inherited from ShapeElement.)
Public methodTranslateToAbsoluteBoundsConverts the relative bounds to absolute bounds for the shape. (Inherited from ShapeElement.)
Public methodTranslateToRelativeBoundsConverts the absolute bounds to relative bounds for the shape. (Inherited from ShapeElement.)
Protected methodUpdateDerivedVisibleUpdates the visible state of the derived shape. (Inherited from ShapeElement.)
Protected methodUpdateEdgePointsUpdates the edge points for the link shape. (Inherited from LinkShape.)
Public methodUpdateGeometryLuminosity(DiagramClientView, Brush)Updates the luminosity for the brush. (Inherited from ShapeElement.)
Public methodUpdateGeometryLuminosity(DiagramClientView, Pen)Updates the luminosity for the pen. (Inherited from ShapeElement.)
Public methodUpdateGraphEdgePointsUpdates the edge points for the link shape and graphs them on the diagram. (Inherited from LinkShape.)
Top

  NameDescription
Public eventClickOccurs when the user clicks the mouse over a shape. (Inherited from ShapeElement.)
Public eventDoubleClickOccurs when the user double-clicks the mouse. (Inherited from ShapeElement.)
Public eventKeyDownOccurs when the user presses a key. (Inherited from ShapeElement.)
Public eventKeyPressOccurs when the user presses and releases a key. (Inherited from ShapeElement.)
Public eventKeyUpOccurs when the user releases a key. (Inherited from ShapeElement.)
Public eventMouseDownOccurs when the user presses the mouse button. (Inherited from ShapeElement.)
Public eventMouseMoveOccurs when the user moves the mouse. (Inherited from ShapeElement.)
Public eventMouseUpOccurs when the user releases the mouse button. (Inherited from ShapeElement.)
Public eventMouseWheelOccurs when the user rotates the mouse wheel. (Inherited from ShapeElement.)
Top

  NameDescription
Public Extension MethodAddExtension(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 MethodAddExtension(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 MethodAddExtension(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 MethodAddExtension(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 MethodAddExtension<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 MethodCanDeleteDeletes the element from the model. (Defined by ImmutabilityExtensionMethods.)
Public Extension MethodGetAllExtensionsReturn an enumerable that performs a breadth first traversal across the tree of extension elements embedded in this ModelElement. (Defined by ModelElementExtensionMethods.)
Public Extension MethodGetBaseElementReturns the root of the virtual MEL in which the specified ModelElement is participating. (Defined by ModelElementExtensionMethods.)
Public Extension MethodGetDslDefinitionModelElementThis 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 MethodGetExtension(Guid)Overloaded. (Defined by ModelElementExtensionMethods.)
Public Extension MethodGetExtension(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 MethodGetExtension(DomainClassInfo)Overloaded. (Defined by ModelElementExtensionMethods.)
Public Extension MethodGetExtension<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 MethodGetLocksGet the lock flags for this element. This will include any locks enabled on the Partition containing the element. (Defined by ImmutabilityExtensionMethods.)
Public Extension MethodIsExtendedBy(Guid)Overloaded. Query whether this ModelElement is currently extended by an ExtensionElement of a particular type. (Defined by ModelElementExtensionMethods.)
Public Extension MethodIsExtendedBy(Type)Overloaded. Query whether this ModelElement is currently extended by an ExtensionElement of a particular type. (Defined by ModelElementExtensionMethods.)
Public Extension MethodIsExtendedBy(DomainClassInfo)Overloaded. Query whether this ModelElement is currently extended by an ExtensionElement of a particular type. (Defined by ModelElementExtensionMethods.)
Public Extension MethodIsLockedTest whether this element has any of a specified set of locks (Defined by ImmutabilityExtensionMethods.)
Public Extension MethodRemoveExtension(Type)Overloaded. Remove any extension of this ModelElement that is of a particular type. (Defined by ModelElementExtensionMethods.)
Public Extension MethodRemoveExtension(Guid)Overloaded. Remove any extension of the specified ModelElement that is of a particular type. (Defined by ModelElementExtensionMethods.)
Public Extension MethodRemoveExtension(DomainClassInfo)Overloaded. Remove any extension of the specified ModelElement that is of a particular type. (Defined by ModelElementExtensionMethods.)
Public Extension MethodRemoveExtension(ExtensionElement)Overloaded. Remove a specified ExtensionElement from the extensions of this ModelElement. (Defined by ModelElementExtensionMethods.)
Public Extension MethodSetLocksSet the lock flags of this element (Defined by ImmutabilityExtensionMethods.)
Public Extension MethodTryGetExtension(Guid)Overloaded. (Defined by ModelElementExtensionMethods.)
Public Extension MethodTryGetExtension(Type)Overloaded. (Defined by ModelElementExtensionMethods.)
Public Extension MethodTryGetExtension(DomainClassInfo)Overloaded. (Defined by ModelElementExtensionMethods.)
Public Extension MethodTryGetExtension<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

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.

Caution noteCaution

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

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft