LinkShape Properties

  • Article

Include Protected Members
Include Inherited Members

The LinkShape type exposes the following members.

Properties

  Name Description
Public property AbsoluteBoundingBox Gets the bounding rectangle of the link shape relative to the diagram. (Overrides ShapeElement.AbsoluteBoundingBox.)
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. (Overrides ShapeElement.AbsoluteBoundingBoxToEnsureVisible.)
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 Gets the name of the shape. (Inherited from ShapeElement.)
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 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. (Overrides ShapeElement.BoundingBox.)
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.
Public property CanMove true if users can reposition the link in the diagram; otherwise, false (Overrides ShapeElement.CanMove.)
Public property CanMoveAnchorPoints If true, the user can move the endpoints of this LinkShape around the boundaries of the connected shapes.
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 Decorators Gets the collection of decorators for the shape. (Inherited from ShapeElement.)
Protected property DecoratorsSize
Protected property DefaultRoutingStyle Gets the default routing style (straight or rectilinear) for the link, set in the DSL Definition.
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.
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.
Public property EndSegmentBreakFactor Gets the length of the link shape and determines how long the last line segment in the link shape must be.
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 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 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. (Overrides ShapeElement.GridSize.)
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. (Overrides ShapeElement.HasShadow.)
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.)
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.
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.
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. (Overrides ShapeElement.OutlinePenId.)
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.
Public property RoutingStyle Straight (from point to point) or rectilinear (made up of a series of horizontal and vertical segments).
Public property ShapeFields Parts of a shape such as text rows and decorators. (Inherited from ShapeElement.)
Public property ShapeGeometry Gets the geometry for the shape, such as Rectangle, RoundedRectangle, or Ellipse, which defines operations associated with the outline of the shape. (Inherited from ShapeElement.)
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.)
Public property TargetToolboxItemFilterAttributes Gets a collection of attributes that determine which items are enabled or disabled in the Toolbox. (Inherited from ShapeElement.)
Public property UserFixed Gets or sets a fixed line segment.
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

See Also

Reference

LinkShape Class

Microsoft.VisualStudio.Modeling.Diagrams Namespace