ShapeElement Members
Include Protected Members
Include Inherited Members
Represents a diagram or a shape or connector in a diagram. ShapeElements encapsulate the visual presentation of model elements.
The ShapeElement type exposes the following members.
Constructors
Name
Description
.gif "Protected method")
Initializes a new instance of the ShapeElement class.
Top
Methods
Name
Description
.gif "Public method")
Performs the default action for the accessible object.
Assigns a model element to the presentation element. The same effect as setting ModelElement. (Inherited from PresentationElement.)
.gif "Static member")
Overloaded. Associates the resource for the shape with an in-memory store property that is assigned to the shape.
Verifies whether the child shape appears.
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.
Selects which child list a new child shape should be added to – NestedChildShapes or RelativeChildShapes.
Allows a shape to determine which other shapes are selected.
Overloaded. Creates a copy of this element in the model.
Creates a shape and adds it as a child to this shape.
Creates a class style set for the shape type.
Creates a collection of decorators for the shape type.
Creates a style set for the shape.
Creates a collection of shape fields for the shape type.
Overloaded. Deletes the element from the model.
Finds the highlighted shape in a chain of shapes.
Calculates the point where a connector will touch the perimeter of a shape. Override this if you define a non-rectangular shape.
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.
Navigates the from shape to shape, using the keyboard.
Draws the resizing feedback for the shape.
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.
Excludes the geometry of a shape and its child shapes from the clipping region.
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Overloaded. Finds the shape decorator that has a given name.
Searches for the first child in the navigation sequence for the shape.
Finds an empty area on the grid for the shape.
Searches for the last child in the navigation sequence for the shape.
Searches for the next child in the navigation sequence for the shape.
Searches for the next shape field in the navigation sequence.
Searches for the previous child in the navigation sequence for the shape.
Searches for the previous shape field in the navigation sequence.
Overloaded. Searches for a shape field in a shape.
Creates or adjusts the child shapes that should be created when a model element is created or updated. Called by Diagram.FixUpDiagram().
Verifies whether the shape has the focus.
Gets the accessible object that is assigned to the shape.
Gets a collection of child shapes that belong to the parent shape.
Gets the pointer that appears when the mouse is over the shape.
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.
Gets the description for a field in the shape.
Gets the name of a field in the shape.
Gets the value for a field in the shape.
Gets the primary element that the child shape represents.
Gets the property information for a field in the shape.
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.
Calculates the luminosity of the shape.
GetSubFieldAccessibleDescription
Gets the description for a child field in the shape.
Gets the name of a child field in the shape.
Gets the value for a child field in the shape.
GetSubFieldRepresentedElements
Gets a collection of elements that the shape for the child field represents.
GetSubFieldRepresentedProperty
Gets the property for the child field.
GetSubFieldRepresentedPropertyElements
Gets the element that contains the property for the child field.
Gets the tooltip text for the shape to which the mouse is pointing.
Gets the type of the current instance. (Inherited from Object.)
Verifies whether the results are cached for the drag-over mouse event.
Hides the shape and all its children.
Hides the custom tooltip for the shape.
Initializes and adds fields to the shape type.
Initializes the resources for an instance of the shape.
Initializes the resources for the shape.
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.
Overloaded. Makes sure that the shape and its immediate surroundings will be repainted at the end of the transaction.
Verifies whether the shape is a descendent of another shape.
Overloaded. Verifies whether the key is used for navigation in the shape.
Iterates through a shape and its child shapes.
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.
Overloaded. Repositions the shapes in the group by the amount that the position of the mouse determines.
Navigates to the next ancestor in the navigation sequence and updates the focus. Called in response to user navigation keystrokes.
Navigates to the next descendent in the navigation sequence and updates the focus. Called in response to user navigation keystrokes.
Navigates to a specific shape in the navigation sequence and updates the focus.
Navigates to the first shape in the navigation sequence in the parent of the current selection. Called in response to user navigation keystrokes.
Navigates to the last shape in the navigation sequence in the parent of the current selection. Called in response to user navigation keystrokes.
Navigates to the next shape in the navigation sequence. Called in response to user navigation keystrokes.
Navigates to the previously selected shape in the navigation sequence. Called in response to user navigation keystrokes.
Updates the shape when the value of an in-memory store property changes for a field in the shape.
Updates resources, such as pens and brushes, before they are used to paint the shape.
Called when the user starts to edit a text field.
Called when the bounds position and size of the parent and children are set or adjusted. Override to modify the size or internal layout.
Called when the positions and sizes of child shapes are about to be determined. Override to set specialized rules.
Called after the size and position of a child shape has been determined.
Called when the user clicks the shape.
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.
Called when the user drags an item onto the shape.
Called when the mouse enters a shape during a drag operation.
Called when the mouse moves out of a shape.
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.
Called when the user ends editing a text field.
Called to initialize the shape. Override this to attach event handlers and rules to this object.
Called when a key is pressed.
Called when a character is typed.
Called when a key is released.
Called when the user presses a mouse key.
Called when the mouse enters a shape.
Called when the mouse hovers over a shape.
Called when the mouse leaves a shape.
Called repeatedly when the user moves the mouse.
Called when a mouse button is released.
Called when the user has rotated the mouse wheel.
Called when a
Called when emphasis has been applied to the selected shape.
Called when drag-and-drop feedback is painted.
Called to paint the selection highlight.
Called to paint the basic parts of the shape.
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.
Called when the shape has been removed as a child shape from its parent shape.
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.
Updates the visibility of the child shape when a change to visibility is made.
Removes the objects that are used to position the shape on the diagram grid.
Removes points for the shape on the diagram grid.
Rebuilds the shape.
Removes the shape, including any relative and nested child shapes, from the diagram grid.
Verifies whether the shape is selected in a specified view.
SetInitialGraphLayoutVisibility
Sets the visibility of the graph.
Sets the visibility of the shape and all its children.
SetShowHideStateImplementation
Sets the visibility of the shape.
Determines whether a shape should be created to represent a given domain class instance on the diagram.
Verifies whether a child shape should be added to a new parent when the child shape is moved.
Makes a shape and all its children visible.
Makes a shape's custom tooltip visible.
Gets the name of the shape and its type. (Overrides Object.ToString().)
TranslateGeometryToAbsoluteBounds
Converts the relative bounds to absolute bounds for the shape's geometry.
TranslateGeometryToRelativeBounds
Converts the absolute bounds to relative bounds for the shape's geometry.
Converts the relative bounds to absolute bounds for the shape.
Converts the absolute bounds to relative bounds for the shape.
Updates the visible state of the derived shape.
Overloaded. Updates the luminosity for the pen or brush.
Top
Fields
Name
Description
.gif "Public field")
Represents the ID that is assigned to the shape.
Top
Properties
Name
Description
.gif "Public property")
The bounding rectangle, measured relative to the Diagram.
AbsoluteBoundingBoxToEnsureVisible
Gets the absolute bounding rectangle for DiagramClientView.EnsureVisible.
Gets the point in the center of the shape.
Gets the accessibility object for the shape.
AccessibleDefaultActionDescription
Gets the default action description for the shape.
Gets the description for the shape.
Gets the Help for the shape.
Gets the Help topic for the shape.
Gets the ID of the Help topic for the shape.
Gets the name of the shape.
Gets the role of the shape.
Gets the state of the shape.
Gets the value of the shape.
If true, the children of this shape can be included in the current selection group.
true if this shape can be resized when the size or position of a child shape is changed.
If true, this shape will reduce in size to fit around its children when they are re-sized or moved.
Gets the ID for the brush that is used to paint the background of the shape.
The bounding rectangle, measured relative to the ParentShape.
Gets the shape and verifies whether it can receive the focus.
Gets the shape and verifies whether a user can move it.
Gets the shape and verifies whether a user can select it.
Gets the point in the center of the shape.
.gif "Protected property")
Gets the style set for the shape.
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.
Gets the collection of decorators for the shape.
Gets the default shape, which is the first shape that can receive focus.
Gets the default size of the shape.
Gets the diagram to which the shape belongs.
Gets the list of event handlers for the shape.
Gets the ID of the brush that is used to paint the background of the geometry.
Gets the bounding box of the shape.
Gets the shape and verifies whether its background is painted.
Gets the shape and verifies whether it has an outline.
true if the shape has a shadow; otherwise, false.
Gets the ID of the pen that draws the outline for the shape.
Gets the style set for the shape.
If non-zero, this shape and its children will snap to a grid of this size. Defaults to ParentShape.GridSize.
true if the shape has child shapes.
Gets the shape and verifies whether it has a custom tooltip.
Gets the shape and verifies whether it has a tooltip.
Gets the shape and verifies whether it has a background.
Gets the shape and verifies whether it is highlighted.
Gets the shape and verifies whether it has an outline.
Gets the shape and verifies whether it has a shadow.
Gets the shape and verifies whether it has a tooltip.
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.
true if this shape element is in the RelativeChildShapes of its ParentShape.
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().
Gets the shape and verifies whether child link shapes should try to align when they are connected to same shape or sets this value.
Gets or sets the target location where the link shape should try to position the shape.
Gets or sets the distance between child link shapes for this shape.
Gets or sets the distance between child link shapes and child node shapes.
Gets the maximum offset for the shadow of the shape.
Gets the maximum size for the shape.
Gets the minimum size for the shape.
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.
Gets the margin between the shape's bounding box and its nested node shapes.
Gets or sets the margin between child node shapes.
Gets the ID of the pen that is used to draw the outline of the shape.
Gets the width of the outline for the shape.
Gets the relationship instance from the shape to the parent shape.
Gets the parent shape element. To appear on a diagram, a shape or connector must have a parent.
Gets or sets the Partition that contains the element. (Inherited from ModelElement.)
Gets the perimeter (path) around the shape.
Gets the related shape to visually emphasize to the user when this shape is selected.
The list of shapes that are part of this shape, but can appear outside the boundaries of this shape.
Parts of a shape such as text rows and decorators.
Gets the geometry for the shape, such as Rectangle, RoundedRectangle, or Ellipse, which defines operations associated with the outline of the shape.
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.
Gets the Store that contains the element. (Inherited from ModelElement.)
Gets an instance of the style set for the shape.
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.
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.
Top
Events
Name
Description
.gif "Public event")
Occurs when the user clicks the mouse over a shape.
Occurs when the user double-clicks the mouse.
Occurs when the user presses a key.
Occurs when the user presses and releases a key.
Occurs when the user releases a key.
Occurs when the user presses the mouse button.
Occurs when the user moves the mouse.
Occurs when the user releases the mouse button.
Occurs when the user rotates the mouse wheel.
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