LinkShape Members
Include Protected Members
Include Inherited Members
Represents a connector line on a diagram. See also BinaryLinkShape.
The LinkShape type exposes the following members.
Constructors
Name
Description
.gif "Protected method")
Initializes a new instance of the LinkShape class.
Top
Methods
Name
Description
.gif "Public method")
Performs the default action for the accessible object. (Inherited from ShapeElement.)
Assigns a model element to the presentation element. The same effect as setting ModelElement. (Inherited from PresentationElement.)
Verifies whether the child shape appears. (Inherited from ShapeElement.)
Verifies whether a source element can be added to this element. (Inherited from ModelElement.)
Overloaded. Selects a target element that the root element should merge with.
Selects a parent shape for a new child shape, typically this shape. (Inherited from ShapeElement.)
Selects which child list a new child shape should be added to – NestedChildShapes or RelativeChildShapes. (Inherited from ShapeElement.)
Allows a shape to determine which other shapes are selected. (Inherited from ShapeElement.)
Overloaded. Creates a copy of this element in the model.
Creates a shape and adds it as a child to this shape. (Inherited from ShapeElement.)
Creates a class style set for the shape type. (Inherited from ShapeElement.)
Creates a collection of decorators for the shape type. (Inherited from ShapeElement.)
Creates a style set for the shape. (Inherited from ShapeElement.)
Creates a collection of shape fields for the shape type. (Inherited from ShapeElement.)
Overloaded. Deletes the element from the model.
Finds the highlighted shape in a chain of shapes. (Inherited from ShapeElement.)
Disconnects the link shape from other shapes.
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.)
Overloaded. Returns true if a specified point is within the shape.
Returns true if a given point is in the selection handles around the shape. (Inherited from ShapeElement.)
Navigates the from shape to shape, using the keyboard. (Inherited from ShapeElement.)
Draws the resizing feedback for the shape. (Inherited from ShapeElement.)
Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Excludes the shape and its child shapes from the clipping region. (Inherited from ShapeElement.)
Excludes the geometry of a shape and its child shapes from the clipping region. (Inherited from ShapeElement.)
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Finds the shape decorator that has a given name. (Inherited from ShapeElement.)
Searches for the first child in the navigation sequence for the shape. (Inherited from ShapeElement.)
Finds an empty area on the grid for the shape. (Inherited from ShapeElement.)
Searches for the last child in the navigation sequence for the shape. (Inherited from ShapeElement.)
Searches for the next child in the navigation sequence for the shape. (Inherited from ShapeElement.)
Searches for the next shape field in the navigation sequence. (Inherited from ShapeElement.)
Searches for the previous child in the navigation sequence for the shape. (Inherited from ShapeElement.)
Searches for the previous shape field in the navigation sequence. (Inherited from ShapeElement.)
Searches for a shape field in a shape. (Inherited from ShapeElement.)
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.)
Verifies whether the shape has the focus. (Inherited from ShapeElement.)
Gets the accessible object that is assigned to the shape. (Inherited from ShapeElement.)
Gets a collection of child shapes that belong to the parent shape. (Inherited from ShapeElement.)
Gets the pointer that appears when the mouse is over the shape. (Inherited from ShapeElement.)
Gets the most-derived domain class for this element. (Inherited from ModelElement.)
Gets the tooltip text that appears when the mouse is over the shape. (Inherited from ShapeElement.)
Use EdgePoints or EdgePointsNoJumps.
Gets the description for a field in the shape. (Inherited from ShapeElement.)
Gets the name of a field in the shape. (Inherited from ShapeElement.)
Gets the value for a field in the shape. (Inherited from ShapeElement.)
Gets the primary element that the child shape represents. (Inherited from ShapeElement.)
Gets the property information for a field in the shape. (Inherited from ShapeElement.)
Serves as a hash function for a particular type. (Inherited from Object.)
Gets the mouse action to perform for a mouse down event over a specific point in the diagram. (Inherited from ShapeElement.)
Calculates the luminosity of the shape. (Inherited from ShapeElement.)
GetSubFieldAccessibleDescription
Gets the description for a child field in the shape. (Inherited from ShapeElement.)
Gets the name of a child field in the shape. (Inherited from ShapeElement.)
Gets the value for a child field in the shape. (Inherited from ShapeElement.)
GetSubFieldRepresentedElements
Gets a collection of elements that the shape for the child field represents. (Inherited from ShapeElement.)
GetSubFieldRepresentedProperty
Gets the property for the child field. (Inherited from ShapeElement.)
GetSubFieldRepresentedPropertyElements
Gets the element that contains the property for the child field. (Inherited from ShapeElement.)
Gets the tooltip text for the shape to which the mouse is pointing. (Inherited from ShapeElement.)
Gets the type of the current instance. (Inherited from Object.)
Verifies whether the results are cached for the drag-over mouse event. (Inherited from ShapeElement.)
Hides the shape and all its children. (Inherited from ShapeElement.)
Hides the custom tooltip for the shape. (Inherited from ShapeElement.)
Initializes and adds fields to the shape type. (Inherited from ShapeElement.)
Initializes the resources for an instance of the shape. (Inherited from ShapeElement.)
Initializes the resources for the shape. (Inherited from ShapeElement.)
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.)
Overloaded.
Verifies whether the shape is a descendent of another shape. (Inherited from ShapeElement.)
Overloaded. Verifies whether the key is used for navigation in the shape.
True if the link shape has been routed and the EdgePoints are valid, false if the link will be routed later.
Iterates through a shape and its child shapes. (Inherited from ShapeElement.)
Creates a shallow copy of the current Object. (Inherited from Object.)
Not used for presentation elements. (Inherited from PresentationElement.)
Disconnects a source element from a target element. (Inherited from ModelElement.)
Creates a relationship between a model element and a group of model elements. (Inherited from PresentationElement.)
Calculates the luminosity of the highlight for the shape. (Inherited from ShapeElement.)
Overloaded. Repositions the shapes in the group by the amount that the position of the mouse determines.
Called in response to user’s keystroke navigation to set the focus to the nearest focusable ancestor. (Overrides ShapeElement.NavigateAscend(SelectedShapesCollection).)
Navigates to the next descendent in the navigation sequence and updates the focus. Called in response to user navigation keystrokes. (Inherited from ShapeElement.)
Navigates to a specific shape in the navigation sequence and updates the focus. (Inherited from ShapeElement.)
Called in response to user’s keystroke navigation to set the focus on the first child of the parent of the current focus. (Overrides ShapeElement.NavigateToFirst(SelectedShapesCollection).)
Called in response to user’s keystroke navigation to set the focus to the last child of the parent of the current focus. (Overrides ShapeElement.NavigateToLast(SelectedShapesCollection).)
Called in response to user’s keystroke navigation to set the focus to the next focusable item in the focus sequence. (Overrides ShapeElement.NavigateToNext(SelectedShapesCollection).)
Called in response to user’s keystroke navigation to set the focus to the previous item in the focusing sequence. (Overrides ShapeElement.NavigateToPrevious(SelectedShapesCollection).)
Updates the shape when the value of an in-memory store property changes for a field in the shape. (Inherited from ShapeElement.)
Updates resources, such as pens and brushes, before they are used to paint the shape. (Inherited from ShapeElement.)
Called when the user starts to edit a text field. (Inherited from ShapeElement.)
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.)
Called when the positions and sizes of child shapes are about to be determined. Override to set specialized rules. (Inherited from ShapeElement.)
Called after the size and position of a child shape has been determined. (Inherited from ShapeElement.)
Called when the user clicks the shape. (Inherited from ShapeElement.)
Alerts listeners that a copy of the element has been created. (Inherited from ModelElement.)
Alerts listeners that an element has been deleted from the model. (Inherited from ModelElement.)
Alerts listeners that the element is being deleted. (Inherited from ModelElement.)
Called when the user double-clicks the shape. (Inherited from ShapeElement.)
Called when the user drags an item onto the shape. (Inherited from ShapeElement.)
Called when the mouse enters a shape during a drag operation. (Inherited from ShapeElement.)
Called when the mouse moves out of a shape. (Inherited from ShapeElement.)
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.)
Called when the user ends editing a text field. (Inherited from ShapeElement.)
Called to initialize the shape. Override this to attach event handlers and rules to this object. (Inherited from ShapeElement.)
Called when a key is pressed. (Inherited from ShapeElement.)
Called when a character is typed. (Inherited from ShapeElement.)
Called when a key is released. (Inherited from ShapeElement.)
Called when the user presses a mouse key. (Inherited from ShapeElement.)
Called when the mouse enters a shape. (Inherited from ShapeElement.)
Called when the mouse hovers over a shape. (Inherited from ShapeElement.)
Called when the mouse leaves a shape. (Inherited from ShapeElement.)
Called repeatedly when the user moves the mouse. (Inherited from ShapeElement.)
Called when a mouse button is released. (Inherited from ShapeElement.)
Called when the user has rotated the mouse wheel. (Inherited from ShapeElement.)
Called when a (Inherited from ShapeElement.)
Called when emphasis has been applied to the selected shape. (Inherited from ShapeElement.)
Called when drag-and-drop feedback is painted. (Inherited from ShapeElement.)
Called to paint the selection highlight. (Inherited from ShapeElement.)
Called to paint the basic parts of the shape. (Inherited from ShapeElement.)
Alerts listeners that an element has been added back to a model. (Inherited from ModelElement.)
Alerts listeners that the position of a role is about to change. (Inherited from ModelElement.)
Allows notification when a role player position has changed. (Inherited from ModelElement.)
Called when a shape has been inserted as a child of another. (Inherited from ShapeElement.)
Called when the shape has been removed as a child shape from its parent shape. (Inherited from ShapeElement.)
Overloaded. Alerts the Domain-Specific Language Designer that a parent shape must be resized to match its child shapes.
Verifies whether the child shape should appear in the diagram. (Inherited from ShapeElement.)
Updates the visibility of the child shape when a change to visibility is made. (Inherited from ShapeElement.)
Removes the objects that are used to position the shape on the diagram grid. (Inherited from ShapeElement.)
Removes points for the shape on the diagram grid. (Inherited from ShapeElement.)
Rebuilds the shape. (Inherited from ShapeElement.)
Removes the shape, including any relative and nested child shapes, from the diagram grid. (Inherited from ShapeElement.)
Verifies whether the shape is selected in a specified view. (Inherited from ShapeElement.)
Use EdgePoints property.
SetInitialGraphLayoutVisibility
Sets the visibility of the graph. (Inherited from ShapeElement.)
Sets the visibility of the shape and all its children. (Inherited from ShapeElement.)
SetShowHideStateImplementation
Sets the visibility of the shape. (Inherited from ShapeElement.)
Determines whether a shape should be created to represent a given domain class instance on the diagram. (Inherited from ShapeElement.)
Verifies whether a child shape should be added to a new parent when the child shape is moved. (Inherited from ShapeElement.)
Makes a shape and all its children visible. (Inherited from ShapeElement.)
Makes a shape's custom tooltip visible. (Inherited from ShapeElement.)
Gets the name of the shape and its type. (Inherited from ShapeElement.)
TranslateGeometryToAbsoluteBounds
Converts the relative bounds to absolute bounds for the shape's geometry. (Inherited from ShapeElement.)
TranslateGeometryToRelativeBounds
Converts the absolute bounds to relative bounds for the shape's geometry. (Inherited from ShapeElement.)
Converts the relative bounds to absolute bounds for the shape. (Inherited from ShapeElement.)
Converts the absolute bounds to relative bounds for the shape. (Inherited from ShapeElement.)
Updates the visible state of the derived shape. (Inherited from ShapeElement.)
Updates the edge points for the link shape.
Overloaded. Updates the luminosity for the pen or brush.
Updates the edge points for the link shape and graphs them on the diagram.
Top
Fields
Name
Description
.gif "Public field")
.gif "Static member")
Represents the ID for the link shape.
Represents the ID that is assigned to the collection of edge points.
ManuallyRoutedDomainPropertyId
Represents the ID that is assigned to the ManuallyRouted flag.
Top
Properties
Name
Description
.gif "Public property")
Gets the bounding rectangle of the link shape relative to the diagram. (Overrides ShapeElement.AbsoluteBoundingBox.)
AbsoluteBoundingBoxToEnsureVisible
Gets the absolute bounding rectangle for DiagramClientView.EnsureVisible. (Inherited from ShapeElement.)
Gets the point in the center of the shape. (Inherited from ShapeElement.)
Gets the accessibility object for the shape. (Inherited from ShapeElement.)
AccessibleDefaultActionDescription
Gets the default action description for the shape. (Inherited from ShapeElement.)
Gets the description for the shape. (Inherited from ShapeElement.)
Gets the Help for the shape. (Inherited from ShapeElement.)
Gets the Help topic for the shape. (Inherited from ShapeElement.)
Gets the ID of the Help topic for the shape. (Inherited from ShapeElement.)
Gets the name of the shape. (Inherited from ShapeElement.)
Gets the role of the shape. (Inherited from ShapeElement.)
Gets the state of the shape. (Inherited from ShapeElement.)
Gets the value of the shape. (Inherited from ShapeElement.)
If true, the children of this shape can be included in the current selection group. (Inherited from ShapeElement.)
true if this shape can be resized when the size or position of a child shape is changed. (Inherited from ShapeElement.)
If true, this shape will reduce in size to fit around its children when they are re-sized or moved. (Inherited from ShapeElement.)
Gets the ID for the brush that is used to paint the background of the shape. (Inherited from ShapeElement.)
Gets the bounding rectangle of the link shape relative to its parent. (Overrides ShapeElement.BoundingBox.)
Gets the shape and verifies whether it can receive the focus. (Inherited from ShapeElement.)
true if users can manually route the link shape between elements in the diagram; otherwise, false.
true if users can reposition the link in the diagram; otherwise, false (Overrides ShapeElement.CanMove.)
Gets the shape and verifies whether a user can select it. (Inherited from ShapeElement.)
Gets the point in the center of the shape. (Inherited from ShapeElement.)
.gif "Protected property")
Gets the style set for the shape. (Inherited from ShapeElement.)
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.)
Gets the collection of decorators for the shape. (Inherited from ShapeElement.)
Gets the default routing style (straight or rectilinear) for the link, set in the DSL Definition.
Gets the default shape, which is the first shape that can receive focus. (Inherited from ShapeElement.)
Gets the default size of the shape. (Inherited from ShapeElement.)
Gets the diagram to which the shape belongs. (Inherited from ShapeElement.)
The ordered list of points bounding the straight segments of the link shape, including two points at each jumps.
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.
Gets the length of the link shape and determines how long the last line segment in the link shape must be.
Gets the list of event handlers for the shape. (Inherited from ShapeElement.)
Gets the ID of the brush that is used to paint the background of the geometry. (Inherited from ShapeElement.)
Gets the bounding box of the shape. (Inherited from ShapeElement.)
Gets the shape and verifies whether its background is painted. (Inherited from ShapeElement.)
Gets the shape and verifies whether it has an outline. (Inherited from ShapeElement.)
true if the shape has a shadow; otherwise, false. (Inherited from ShapeElement.)
Gets the ID of the pen that draws the outline for the shape. (Inherited from ShapeElement.)
Gets the style set for the shape. (Inherited from ShapeElement.)
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.)
true if the shape has child shapes. (Inherited from ShapeElement.)
Gets the shape and verifies whether it has a custom tooltip. (Inherited from ShapeElement.)
Gets the shape and verifies whether it has a tooltip. (Inherited from ShapeElement.)
Gets the shape and verifies whether it has a background. (Inherited from ShapeElement.)
Gets the shape and verifies whether it is highlighted. (Inherited from ShapeElement.)
Gets the shape and verifies whether it has an outline. (Inherited from ShapeElement.)
If true, the link is painted with a shadow. (Overrides ShapeElement.HasShadow.)
Gets the shape and verifies whether it has a tooltip. (Inherited from ShapeElement.)
Gets the ID of the element. (Inherited from ModelElement.)
Gets the IsActive flag and verifies to see whether the element is active. (Inherited from ModelElement.)
Gets the IsDeleted flag and checks to see whether the element has been deleted from the model. (Inherited from ModelElement.)
Gets the IsDeleting flag and verifies whether the element is currently being deleted from the model. (Inherited from ModelElement.)
true if this shape element is in the NestedChildShapes of its ParentShape. (Inherited from ShapeElement.)
true if this shape element is in the RelativeChildShapes of its ParentShape. (Inherited from ShapeElement.)
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.)
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.)
Gets or sets the target location where the link shape should try to position the shape. (Inherited from ShapeElement.)
Gets or sets the distance between child link shapes for this shape. (Inherited from ShapeElement.)
Gets or sets the distance between child link shapes and child node shapes. (Inherited from ShapeElement.)
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.
Gets the maximum size for the shape. (Inherited from ShapeElement.)
Gets the minimum size for the shape. (Inherited from ShapeElement.)
Gets or sets the model element that is associated with the presentation element. (Inherited from PresentationElement.)
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.)
Gets the margin between the shape's bounding box and its nested node shapes. (Inherited from ShapeElement.)
Gets a list of shapes that are connected to the link shape.
Gets or sets the margin between child node shapes. (Inherited from ShapeElement.)
Gets the ID of the pen that is used to draw the outline of the link shape. (Overrides ShapeElement.OutlinePenId.)
Gets the width of the outline for the shape. (Inherited from ShapeElement.)
Gets the relationship instance from the shape to the parent shape. (Inherited from ShapeElement.)
Gets the parent shape element. To appear on a diagram, a shape or connector must have a parent. (Inherited from ShapeElement.)
Gets or sets the Partition that contains the element. (Inherited from ModelElement.)
Gets the perimeter (path) around the shape. (Inherited from ShapeElement.)
Gets the related shape to visually emphasize to the user when this shape is selected. (Inherited from ShapeElement.)
The list of shapes that are part of this shape, but can appear outside the boundaries of this shape. (Inherited from ShapeElement.)
Gets or sets whether the link creates a jump where it crosses another link.
Straight (from point to point) or rectilinear (made up of a series of horizontal and vertical segments).
Parts of a shape such as text rows and decorators. (Inherited from ShapeElement.)
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.)
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.)
Gets the Store that contains the element. (Inherited from ModelElement.)
Gets an instance of the style set for the shape. (Inherited from ShapeElement.)
Gets or sets the subject for the presentation element. Defaults to the same object as ModelElement. (Inherited from PresentationElement.)
TargetToolboxItemFilterAttributes
Gets a collection of attributes that determine which items are enabled or disabled in the Toolbox. (Inherited from ShapeElement.)
Gets or sets a fixed line segment.
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
Events
Name
Description
.gif "Public event")
Occurs when the user clicks the mouse over a shape. (Inherited from ShapeElement.)
Occurs when the user double-clicks the mouse. (Inherited from ShapeElement.)
Occurs when the user presses a key. (Inherited from ShapeElement.)
Occurs when the user presses and releases a key. (Inherited from ShapeElement.)
Occurs when the user releases a key. (Inherited from ShapeElement.)
Occurs when the user presses the mouse button. (Inherited from ShapeElement.)
Occurs when the user moves the mouse. (Inherited from ShapeElement.)
Occurs when the user releases the mouse button. (Inherited from ShapeElement.)
Occurs when the user rotates the mouse wheel. (Inherited from ShapeElement.)
Top
Explicit Interface Implementations
Name
Description
.gif "Explicit interface implemetation")
.gif "Private method")
(Inherited from ModelElement.)
Overloaded.
(Inherited from ModelElement.)
IMergeElements.MergeDisconnect
(Inherited from ModelElement.)
(Inherited from ModelElement.)
Top