ShapeElement Class

 

Represents a diagram or a shape or connector in a diagram. ShapeElements encapsulate the visual presentation of model elements.

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


[DisplayNameResourceAttribute("Microsoft.VisualStudio.Modeling.Diagrams.ShapeElement.DisplayName", 
	typeof(CoreDesignSurfaceDomainModel), "Microsoft.VisualStudio.Modeling.Diagrams.GeneratedCode.DomainModelResx")]
[DescriptionResourceAttribute("Microsoft.VisualStudio.Modeling.Diagrams.ShapeElement.Description", 
	typeof(CoreDesignSurfaceDomainModel), "Microsoft.VisualStudio.Modeling.Diagrams.GeneratedCode.DomainModelResx")]
[DomainModelOwnerAttribute(typeof(CoreDesignSurfaceDomainModel))]
[CLSCompliantAttribute(true)]
[DomainObjectIdAttribute("ffb3d9f5-7a47-4e12-8501-0055bd018825")]
public abstract class ShapeElement : PresentationElement, IGeometryHost

NameDescription
System_CAPS_protmethodShapeElement(Partition, PropertyAssignment[])

Initializes a new instance of the ShapeElement class.

NameDescription
System_CAPS_pubpropertyAbsoluteBoundingBox

The bounding rectangle, measured relative to the Diagram.

System_CAPS_pubpropertyAbsoluteBoundingBoxToEnsureVisible

Gets the absolute bounding rectangle for DiagramClientView.EnsureVisible.

System_CAPS_pubpropertyAbsoluteCenter

Gets the point in the center of the shape.

System_CAPS_pubpropertyAccessibilityObject

Gets the accessibility object for the shape.

System_CAPS_pubpropertyAccessibleDefaultActionDescription

Gets the default action description for the shape.

System_CAPS_pubpropertyAccessibleDescription

Gets the description for the shape.

System_CAPS_pubpropertyAccessibleHelp

Gets the Help for the shape.

System_CAPS_pubpropertyAccessibleHelpTopicFileName

Gets the Help topic for the shape.

System_CAPS_pubpropertyAccessibleHelpTopicId

Gets the ID of the Help topic for the shape.

System_CAPS_pubpropertyAccessibleName

Gets the name of the shape.

System_CAPS_pubpropertyAccessibleRole

Gets the role of the shape.

System_CAPS_pubpropertyAccessibleState

Gets the state of the shape.

System_CAPS_pubpropertyAccessibleValue

Gets the value of the shape.

System_CAPS_pubpropertyAllowsChildrenInSelection

If true, the children of this shape can be included in the current selection group.

System_CAPS_pubpropertyAllowsChildrenToResizeParent

true if this shape can be resized when the size or position of a child shape is changed.

System_CAPS_pubpropertyAllowsChildrenToShrinkParent

If true, this shape will reduce in size to fit around its children when they are re-sized or moved.

System_CAPS_pubpropertyBackgroundBrushId

Gets the ID for the brush that is used to paint the background of the shape.

System_CAPS_pubpropertyBoundingBox

The bounding rectangle, measured relative to the ParentShape.

System_CAPS_pubpropertyCanFocus

Gets the shape and verifies whether it can receive the focus.

System_CAPS_pubpropertyCanMove

Gets the shape and verifies whether a user can move it.

System_CAPS_pubpropertyCanSelect

Gets the shape and verifies whether a user can select it.

System_CAPS_pubpropertyCenter

Gets the point in the center of the shape.

System_CAPS_protpropertyClassStyleSet

Gets the style set for the shape.

System_CAPS_pubpropertyClipWhenDrawingFields

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.

System_CAPS_pubpropertyDecorators

Gets the collection of decorators for the shape.

System_CAPS_pubpropertyDefaultShapeField

Gets the default shape, which is the first shape that can receive focus.

System_CAPS_pubpropertyDefaultSize

Gets the default size of the shape.

System_CAPS_pubpropertyDiagram

Gets the diagram to which the shape belongs.

System_CAPS_pubpropertyEnsureVisiblePreference

Preferences for the EnsureVisible method for this Shape. Default value is to return the VisiblePreference for the Diagram hosting this Shape.

System_CAPS_protpropertyEvents

Gets the list of event handlers for the shape.

System_CAPS_pubpropertyGeometryBackgroundBrushId

Gets the ID of the brush that is used to paint the background of the geometry.

System_CAPS_pubpropertyGeometryBoundingBox

Gets the bounding box of the shape.

System_CAPS_pubpropertyGeometryHasFilledBackground

Gets the shape and verifies whether its background is painted.

System_CAPS_pubpropertyGeometryHasOutline

Gets the shape and verifies whether it has an outline.

System_CAPS_pubpropertyGeometryHasShadow

true if the shape has a shadow; otherwise, false.

System_CAPS_pubpropertyGeometryOutlinePenId

Gets the ID of the pen that draws the outline for the shape.

System_CAPS_pubpropertyGeometryStyleSet

Gets the style set for the shape.

System_CAPS_pubpropertyGridSize

If non-zero, this shape and its children will snap to a grid of this size. Defaults to ParentShape.GridSize.

System_CAPS_pubpropertyHasChildren

true if the shape has child shapes.

System_CAPS_protpropertyHasCustomToolTip

Gets the shape and verifies whether it has a custom tooltip.

System_CAPS_pubpropertyHasDragOverToolTip

Gets the shape and verifies whether it has a tooltip.

System_CAPS_pubpropertyHasFilledBackground

Gets the shape and verifies whether it has a background.

System_CAPS_pubpropertyHasHighlighting

Gets the shape and verifies whether it is highlighted.

System_CAPS_pubpropertyHasOutline

Gets the shape and verifies whether it has an outline.

System_CAPS_pubpropertyHasShadow

Gets the shape and verifies whether it has a shadow.

System_CAPS_pubpropertyHasToolTip

Gets the shape and verifies whether it has a tooltip.

System_CAPS_pubpropertyId

Gets the ID of the element.(Inherited from ModelElement.)

System_CAPS_pubpropertyIsActive

Gets the IsActive flag and verifies to see whether the element is active.(Inherited from ModelElement.)

System_CAPS_pubpropertyIsDeleted

Gets the IsDeleted flag and checks to see whether the element has been deleted from the model.(Inherited from ModelElement.)

System_CAPS_pubpropertyIsDeleting

Gets the IsDeleting flag and verifies whether the element is currently being deleted from the model.(Inherited from ModelElement.)

System_CAPS_pubpropertyIsNestedChild

true if this shape element is in the NestedChildShapes of its ParentShape.

System_CAPS_pubpropertyIsRelativeChild

true if this shape element is in the RelativeChildShapes of its ParentShape.

System_CAPS_pubpropertyIsVisible

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().

System_CAPS_pubpropertyLineAdjustAwayDefault

Gets the shape and verifies whether child link shapes should try to align when they are connected to same shape or sets this value.

System_CAPS_pubpropertyLineAffinityDefault

Gets or sets the target location where the link shape should try to position the shape.

System_CAPS_pubpropertyLineToLineClearance

Gets or sets the distance between child link shapes for this shape.

System_CAPS_pubpropertyLineToNodeClearance

Gets or sets the distance between child link shapes and child node shapes.

System_CAPS_pubpropertySystem_CAPS_staticMaximumShadowOffset

Gets the maximum offset for the shadow of the shape.

System_CAPS_pubpropertyMaximumSize

Gets the maximum size for the shape.

System_CAPS_pubpropertyMinimumSize

Gets the minimum size for the shape.

System_CAPS_pubpropertyModelElement

Gets or sets the model element that is associated with the presentation element.(Inherited from PresentationElement.)

System_CAPS_pubpropertyNestedChildShapes

The list of shapes that are part of this shape, and are constrained to appear within the boundaries of this shape or diagram.

System_CAPS_pubpropertyNestedShapesMargin

Gets the margin between the shape's bounding box and its nested node shapes.

System_CAPS_pubpropertyNodeToNodeClearance

Gets or sets the margin between child node shapes.

System_CAPS_pubpropertyOutlinePenId

Gets the ID of the pen that is used to draw the outline of the shape.

System_CAPS_pubpropertyOutlinePenWidth

Gets the width of the outline for the shape.

System_CAPS_protpropertyPaintMoveableDecoratorSelectionLines

System_CAPS_protpropertyParentLink

Gets the relationship instance from the shape to the parent shape.

System_CAPS_pubpropertyParentShape

Gets the parent shape element. To appear on a diagram, a shape or connector must have a parent.

System_CAPS_pubpropertyPartition

Gets or sets the Partition that contains the element.(Inherited from ModelElement.)

System_CAPS_pubpropertyPerimeter

Gets the perimeter (path) around the shape.

System_CAPS_pubpropertyRelatedShapeToEmphasize

Gets the related shape to visually emphasize to the user when this shape is selected.

System_CAPS_pubpropertyRelativeChildShapes

The list of shapes that are part of this shape, but can appear outside the boundaries of this shape.

System_CAPS_pubpropertyShapeFields

Parts of a shape such as text rows and decorators.

System_CAPS_pubpropertyShapeGeometry

Gets the geometry for the shape, such as Rectangle, RoundedRectangle, or Ellipse, which defines operations associated with the outline of the shape.

System_CAPS_pubpropertyShouldTryParentShapeForMergeOnToolboxDoubleClick

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.

System_CAPS_pubpropertyStore

Gets the Store that contains the element.(Inherited from ModelElement.)

System_CAPS_pubpropertyStyleSet

Gets an instance of the style set for the shape.

System_CAPS_pubpropertySubject

Gets or sets the subject for the presentation element. Defaults to the same object as ModelElement.(Inherited from PresentationElement.)

System_CAPS_pubpropertyTargetToolboxItemFilterAttributes

Gets a collection of attributes that determine which items are enabled or disabled in the Toolbox.

System_CAPS_pubpropertyZOrder

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.

NameDescription
System_CAPS_pubmethodAccessibleDoDefaultAction()

Performs the default action for the accessible object.

System_CAPS_pubmethodAssociate(ModelElement)

Assigns a model element to the presentation element. The same effect as setting ModelElement.(Inherited from PresentationElement.)

System_CAPS_pubmethodSystem_CAPS_staticAssociateValueWith(Store, AssociatedPropertyInfo)

Associates the resource for the shape with an in-memory store property that is assigned to the shape.

System_CAPS_pubmethodSystem_CAPS_staticAssociateValueWith(Store, Guid)

Associates the resource for the shape with an in-memory store property that is assigned to the shape.

System_CAPS_protmethodCalculateDerivedVisible(ShapeElement)

Verifies whether the child shape appears.

System_CAPS_protmethodCanMerge(ProtoElementBase, ElementGroupPrototype)

Verifies whether a source element can be added to this element.(Inherited from ModelElement.)

System_CAPS_protmethodChooseMergeTarget(ElementGroup)

Selects a target element to accept as its child an element that the user wants to copy, drag, or create.(Inherited from ModelElement.)

System_CAPS_protmethodChooseMergeTarget(ElementGroupPrototype)

Selects a target element to accept as its child an element that the user wants to copy, drag, or create.(Inherited from ModelElement.)

System_CAPS_pubmethodChooseParentShape(ShapeElement)

Selects a parent shape for a new child shape, typically this shape.

System_CAPS_protmethodChooseRelationship(ShapeElement)

Selects which child list a new child shape should be added to – NestedChildShapes or RelativeChildShapes.

System_CAPS_pubmethodCoerceSelection(DiagramItem, DiagramClientView, Boolean)

Allows a shape to determine which other shapes are selected.

System_CAPS_pubmethodCopy()

Creates a copy of the element in the model.(Inherited from ModelElement.)

System_CAPS_pubmethodCopy(IEnumerable<Guid>)

Creates a copy of the element and its child links and elements. (Inherited from ModelElement.)

System_CAPS_protmethodCreateChildShape(ModelElement)

Creates a shape and adds it as a child to this shape.

System_CAPS_protmethodCreateClassStyleSet()

Creates a class style set for the shape type.

System_CAPS_protmethodCreateDecorators()

Creates a collection of decorators for the shape type.

System_CAPS_protmethodCreateInstanceStyleSet()

Creates a style set for the shape.

System_CAPS_protmethodCreateShapeFields()

Creates a collection of shape fields for the shape type.

System_CAPS_pubmethodDelete()

Deletes an element from the model.(Inherited from ModelElement.)

System_CAPS_pubmethodDelete(Guid[])

Deletes an element from the model.(Inherited from ModelElement.)

System_CAPS_protmethodDetermineHighlightShape(ShapeElement)

Finds the highlighted shape in a chain of shapes.

System_CAPS_pubmethodDoFoldToShape(PointD, PointD)

Calculates the point where a connector will touch the perimeter of a shape. Override this if you define a non-rectangular shape.

System_CAPS_pubmethodDoHitTest(PointD, DiagramHitTestInfo)

Returns true if the specified point is within the shape.

System_CAPS_pubmethodDoHitTest(PointD, DiagramHitTestInfo, Boolean)

Returns true if the specified point is within the shape.

System_CAPS_pubmethodDoHitTestSelection(PointD, DiagramHitTestInfo)

Returns true if a given point is in the selection handles around the shape.

System_CAPS_pubmethodDoKeyboardNavigation(Keys, DiagramClientView)

Navigates the from shape to shape, using the keyboard.

System_CAPS_pubmethodDrawResizeFeedback(DiagramPaintEventArgs, RectangleD)

Draws the resizing feedback for the shape.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodExcludeFromClipRegion(Graphics, Matrix, GraphicsPath)

Excludes the shape and its child shapes from the clipping region.

System_CAPS_pubmethodExcludeGeometryFromClipRegion(Graphics, Matrix, GraphicsPath)

Excludes the geometry of a shape and its child shapes from the clipping region.

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodSystem_CAPS_staticFindDecorator(IList<Decorator>, String)

Finds the shape decorator that has a given name.

System_CAPS_pubmethodFindDecorator(String)

Finds the shape decorator that has a given name.

System_CAPS_pubmethodFindFirstChild(Boolean)

Searches for the first child in the navigation sequence for the shape.

System_CAPS_pubmethodFindFreeArea(Double, Double, Double, Double, Double, Double, Double, Double, Double, Double, Double, Double)

Finds an empty area on the grid for the shape.

System_CAPS_pubmethodFindLastChild(Boolean)

Searches for the last child in the navigation sequence for the shape.

System_CAPS_pubmethodFindNextChild(DiagramItem, Boolean)

Searches for the next child in the navigation sequence for the shape.

System_CAPS_pubmethodFindNextInChildFields(ShapeField, Boolean)

Searches for the next shape field in the navigation sequence.

System_CAPS_pubmethodFindPreviousChild(DiagramItem, Boolean)

Searches for the previous child in the navigation sequence for the shape.

System_CAPS_pubmethodFindPreviousInChildFields(ShapeField, Boolean)

Searches for the previous shape field in the navigation sequence.

System_CAPS_pubmethodSystem_CAPS_staticFindShapeField(IList<ShapeField>, String)

Searches for a shape field in a shape.

System_CAPS_pubmethodFindShapeField(String)

Searches for a shape field in a shape.

System_CAPS_pubmethodFixUpChildShapes(ModelElement)

Creates or adjusts the child shapes that should be created when a model element is created or updated. Called by Diagram.FixUpDiagram().

System_CAPS_pubmethodFocused(DiagramClientView)

Verifies whether the shape has the focus.

System_CAPS_pubmethodGetAccessibilityObject(DiagramClientView)

Gets the accessible object that is assigned to the shape.

System_CAPS_pubmethodGetChildElements(ModelElement)

Gets a collection of child shapes that belong to the parent shape.

System_CAPS_pubmethodGetCursor(Cursor, DiagramClientView, PointD)

Gets the pointer that appears when the mouse is over the shape.

System_CAPS_pubmethodGetDomainClass()

Gets the most-derived domain class for this element.(Inherited from ModelElement.)

System_CAPS_pubmethodGetDragOverToolTipText(DiagramItem)

Gets the tooltip text that appears when the mouse is over the shape.

System_CAPS_pubmethodGetFieldAccessibleDescription(ShapeField)

Gets the description for a field in the shape.

System_CAPS_pubmethodGetFieldAccessibleName(ShapeField)

Gets the name of a field in the shape.

System_CAPS_pubmethodGetFieldAccessibleValue(ShapeField)

Gets the value for a field in the shape.

System_CAPS_pubmethodGetFieldRepresentedElement(ShapeField)

Gets the primary element that the child shape represents.

System_CAPS_pubmethodGetFieldRepresentedProperty(ShapeField)

Gets the property information for a field in the shape.

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetPotentialMouseAction(MouseButtons, PointD, DiagramHitTestInfo)

Gets the mouse action to perform for a mouse down event over a specific point in the diagram.

System_CAPS_protmethodGetRoleCollection<TCollection, TElement>(Guid)

Gets or creates the linked element collection(Inherited from ModelElement.)

System_CAPS_pubmethodGetShapeLuminosity(DiagramClientView, Color)

Calculates the luminosity of the shape.

System_CAPS_pubmethodGetSubFieldAccessibleDescription(ShapeField, ShapeSubField)

Gets the description for a child field in the shape.

System_CAPS_pubmethodGetSubFieldAccessibleName(ShapeField, ShapeSubField)

Gets the name of a child field in the shape.

System_CAPS_pubmethodGetSubFieldAccessibleValue(ShapeField, ShapeSubField)

Gets the value for a child field in the shape.

System_CAPS_pubmethodGetSubFieldRepresentedElements(ShapeField, ShapeSubField)

Gets a collection of elements that the shape for the child field represents.

System_CAPS_pubmethodGetSubFieldRepresentedProperty(ShapeField, ShapeSubField)

Gets the property for the child field.

System_CAPS_pubmethodGetSubFieldRepresentedPropertyElements(ShapeField, ShapeSubField)

Gets the element that contains the property for the child field.

System_CAPS_pubmethodGetToolTipText(DiagramItem)

Gets the tooltip text for the shape to which the mouse is pointing.

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodHasCachedDragOverResult(DiagramDragEventArgs)

Verifies whether the results are cached for the drag-over mouse event.

System_CAPS_pubmethodHide()

Hides the shape and all its children.

System_CAPS_protmethodHideCustomToolTip(IWin32Window)

Hides the custom tooltip for the shape.

System_CAPS_protmethodInitializeDecorators(IList<ShapeField>, IList<Decorator>)

Initializes and adds fields to the shape type.

System_CAPS_protmethodInitializeInstanceResources()

Initializes the resources for an instance of the shape.

System_CAPS_protmethodInitializeResources(StyleSet)

Initializes the resources for the shape.

System_CAPS_protmethodInitializeShapeFields(IList<ShapeField>)

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.

System_CAPS_pubmethodInvalidate()

Makes sure that the shape and its immediate surroundings will be repainted at the end of the transaction.

System_CAPS_pubmethodInvalidate(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.

System_CAPS_pubmethodInvalidate(RectangleD)

Makes sure that the shape and its old location will be repainted at the end of the transaction.

System_CAPS_pubmethodIsDescendantOf(ShapeElement)

Verifies whether the shape is a descendent of another shape.

System_CAPS_protmethodIsNavigationKey(Char)

Verifies whether the key is used as a navigational command.

System_CAPS_protmethodIsNavigationKey(Keys)

Verifies whether the key data is used as a navigational command.

System_CAPS_pubmethodIterateShapes(IShapeIterator)

Iterates through a shape and its child shapes.

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_protmethodMergeConfigure(ElementGroup)

Not used for presentation elements.(Inherited from PresentationElement.)

System_CAPS_protmethodMergeDisconnect(ModelElement)

Disconnects a source element from a target element.(Inherited from ModelElement.)

System_CAPS_protmethodMergeRelate(ModelElement, ElementGroup)

Creates a relationship between a model element and a group of model elements.(Inherited from PresentationElement.)

System_CAPS_protmethodModifyLuminosity(Int32, DiagramClientView)

Calculates the luminosity of the highlight for the shape.

System_CAPS_protmethodMoveByRepositioning(DiagramDragEventArgs)

Repositions the shapes in the group by the amount that the position of the mouse determines.

System_CAPS_pubmethodMoveByRepositioning(ElementGroupPrototype, DiagramItemCollection, PointD, DiagramItem)

Repositions the shapes in the group by the amount that the position of the mouse determines.

System_CAPS_pubmethodNavigateAscend(SelectedShapesCollection)

Navigates to the next ancestor in the navigation sequence and updates the focus. Called in response to user navigation keystrokes.

System_CAPS_pubmethodNavigateDescend(SelectedShapesCollection)

Navigates to the next descendent in the navigation sequence and updates the focus. Called in response to user navigation keystrokes.

System_CAPS_protmethodNavigateTo(DiagramItem, SelectedShapesCollection)

Navigates to a specific shape in the navigation sequence and updates the focus.

System_CAPS_pubmethodNavigateToFirst(SelectedShapesCollection)

Navigates to the first shape in the navigation sequence in the parent of the current selection. Called in response to user navigation keystrokes.

System_CAPS_pubmethodNavigateToLast(SelectedShapesCollection)

Navigates to the last shape in the navigation sequence in the parent of the current selection. Called in response to user navigation keystrokes.

System_CAPS_pubmethodNavigateToNext(SelectedShapesCollection)

Navigates to the next shape in the navigation sequence. Called in response to user navigation keystrokes.

System_CAPS_pubmethodNavigateToPrevious(SelectedShapesCollection)

Navigates to the previously selected shape in the navigation sequence. Called in response to user navigation keystrokes.

System_CAPS_protmethodOnAssociatedPropertyChanged(PropertyChangedEventArgs)

Updates the shape when the value of an in-memory store property changes for a field in the shape.

System_CAPS_protmethodOnBeforePaint()

Updates resources, such as pens and brushes, before they are used to paint the shape.

System_CAPS_pubmethodOnBeginEdit(DiagramItemEventArgs)

Called when the user starts to edit a text field.

System_CAPS_pubmethodOnBoundsFixup(BoundsFixupState, Int32, Boolean)

Called when the bounds position and size of the parent and children are set or adjusted. Override to modify the size or internal layout.

System_CAPS_protmethodOnChildConfigured(ShapeElement, Boolean, Boolean)

Called when the positions and sizes of child shapes are about to be determined. Override to set specialized rules.

System_CAPS_protmethodOnChildConfiguring(ShapeElement, Boolean)

Called after the size and position of a child shape has been determined.

System_CAPS_pubmethodOnClick(DiagramPointEventArgs)

Called when the user clicks the shape.

System_CAPS_protmethodOnCopy(ModelElement)

Called when this element has been created as a copy of another element.(Inherited from ModelElement.)

System_CAPS_protmethodOnDeleted()

Called when this element has been deleted from the model.(Inherited from ModelElement.)

System_CAPS_protmethodOnDeleting()

Called when this element is about to be deleted.(Inherited from ModelElement.)

System_CAPS_pubmethodOnDoubleClick(DiagramPointEventArgs)

Called when the user double-clicks the shape.

System_CAPS_pubmethodOnDragDrop(DiagramDragEventArgs)

Called when the user drags an item onto the shape.

System_CAPS_pubmethodOnDragEnter(DiagramDragEventArgs)

Called when the mouse enters a shape during a drag operation.

System_CAPS_pubmethodOnDragLeave(DiagramPointEventArgs)

Called when the mouse moves out of a shape.

System_CAPS_pubmethodOnDragOver(DiagramDragEventArgs)

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.

System_CAPS_pubmethodOnEndEdit(DiagramItemEventArgs)

Called when the user ends editing a text field.

System_CAPS_pubmethodOnInitialize()

Called to initialize the shape. Override this to attach event handlers and rules to this object.

System_CAPS_pubmethodOnKeyDown(DiagramKeyEventArgs)

Called when a key is pressed.

System_CAPS_pubmethodOnKeyPress(DiagramKeyPressEventArgs)

Called when a character is typed.

System_CAPS_pubmethodOnKeyUp(DiagramKeyEventArgs)

Called when a key is released.

System_CAPS_pubmethodOnMouseDown(DiagramMouseEventArgs)

Called when the user presses a mouse key.

System_CAPS_pubmethodOnMouseEnter(DiagramPointEventArgs)

Called when the mouse enters a shape.

System_CAPS_pubmethodOnMouseHover(DiagramPointEventArgs)

Called when the mouse hovers over a shape.

System_CAPS_pubmethodOnMouseLeave(DiagramPointEventArgs)

Called when the mouse leaves a shape.

System_CAPS_pubmethodOnMouseMove(DiagramMouseEventArgs)

Called repeatedly when the user moves the mouse.

System_CAPS_pubmethodOnMouseUp(DiagramMouseEventArgs)

Called when a mouse button is released.

System_CAPS_pubmethodOnMouseWheel(DiagramMouseEventArgs)

Called when the user has rotated the mouse wheel.

System_CAPS_pubmethodOnOrphaned(SerializationResult)

Called when a

System_CAPS_pubmethodOnPaintEmphasis(DiagramPaintEventArgs)

Called when emphasis has been applied to the selected shape.

System_CAPS_pubmethodOnPaintFeedback(DiagramPaintEventArgs)

Called when drag-and-drop feedback is painted.

System_CAPS_pubmethodOnPaintSelection(DiagramPaintEventArgs)

Called to paint the selection highlight.

System_CAPS_pubmethodOnPaintShape(DiagramPaintEventArgs)

Called to paint the basic parts of the shape.

System_CAPS_protmethodOnResurrected()

Called when this element has been added back to a model.(Inherited from ModelElement.)

System_CAPS_protmethodOnRolePlayerPositionChanged(DomainRoleInfo, ElementLink, Int32, Int32)

Called when the position of a role has changed.(Inherited from ModelElement.)

System_CAPS_protmethodOnRolePlayerPositionChanging(DomainRoleInfo, ElementLink, Int32, Int32)

Called when a role player position is about to change.(Inherited from ModelElement.)

System_CAPS_pubmethodOnShapeInserted()

Called when a shape has been inserted as a child of another.

System_CAPS_pubmethodOnShapeRemoved()

Called when the shape has been removed as a child shape from its parent shape.

System_CAPS_pubmethodPerformResizeParentRule()

Alerts the Domain-Specific Language Designer that a parent shape must be resized to match its child shapes.

System_CAPS_pubmethodPerformResizeParentRule(Boolean, ShapeElement)

Alerts the Domain-Specific Language Designer that a parent shape must be resized to match its child shapes.

System_CAPS_protmethodPermitChildVisibility(ShapeElement)

Verifies whether the child shape should appear in the diagram.

System_CAPS_protmethodProcessVisibilityChange(Boolean)

Updates the visibility of the child shape when a change to visibility is made.

System_CAPS_pubmethodPurgeLayoutObjects()

Removes the objects that are used to position the shape on the diagram grid.

System_CAPS_pubmethodPurgePoints()

Removes points for the shape on the diagram grid.

System_CAPS_pubmethodRebuildShape()

Rebuilds the shape.

System_CAPS_pubmethodRemoveLayoutObject()

Removes the shape, including any relative and nested child shapes, from the diagram grid.

System_CAPS_pubmethodSelected(DiagramClientView)

Verifies whether the shape is selected in a specified view.

System_CAPS_protmethodSetInitialGraphLayoutVisibility()

Sets the visibility of the graph.

System_CAPS_pubmethodSetShowHideState(Boolean)

Sets the visibility of the shape and all its children.

System_CAPS_protmethodSetShowHideStateImplementation(Boolean)

Sets the visibility of the shape.

System_CAPS_protmethodShouldAddShapeForElement(ModelElement)

Determines whether a shape should be created to represent a given domain class instance on the diagram.

System_CAPS_pubmethodShouldReparentOnMove()

Verifies whether a child shape should be added to a new parent when the child shape is moved.

System_CAPS_pubmethodShow()

Makes a shape and all its children visible.

System_CAPS_protmethodShowCustomToolTip(String, IWin32Window, Point)

Makes a shape's custom tooltip visible.

System_CAPS_pubmethodToString()

Gets the name of the shape and its type.(Overrides Object.ToString().)

System_CAPS_pubmethodTranslateGeometryToAbsoluteBounds(RectangleD)

Converts the relative bounds to absolute bounds for the shape's geometry.

System_CAPS_pubmethodTranslateGeometryToRelativeBounds(RectangleD)

Converts the absolute bounds to relative bounds for the shape's geometry.

System_CAPS_pubmethodTranslateToAbsoluteBounds(RectangleD)

Converts the relative bounds to absolute bounds for the shape.

System_CAPS_pubmethodTranslateToRelativeBounds(RectangleD)

Converts the absolute bounds to relative bounds for the shape.

System_CAPS_protmethodUpdateDerivedVisible(ShapeElement)

Updates the visible state of the derived shape.

System_CAPS_pubmethodUpdateGeometryLuminosity(DiagramClientView, Brush)

Updates the luminosity for the brush.

System_CAPS_pubmethodUpdateGeometryLuminosity(DiagramClientView, Pen)

Updates the luminosity for the pen.

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticDomainClassId

Represents the ID that is assigned to the shape.

NameDescription
System_CAPS_pubeventClick

Occurs when the user clicks the mouse over a shape.

System_CAPS_pubeventDoubleClick

Occurs when the user double-clicks the mouse.

System_CAPS_pubeventKeyDown

Occurs when the user presses a key.

System_CAPS_pubeventKeyPress

Occurs when the user presses and releases a key.

System_CAPS_pubeventKeyUp

Occurs when the user releases a key.

System_CAPS_pubeventMouseDown

Occurs when the user presses the mouse button.

System_CAPS_pubeventMouseMove

Occurs when the user moves the mouse.

System_CAPS_pubeventMouseUp

Occurs when the user releases the mouse button.

System_CAPS_pubeventMouseWheel

Occurs when the user rotates the mouse wheel.

NameDescription
System_CAPS_pubmethodAddExtension(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.)

System_CAPS_pubmethodAddExtension(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.)

System_CAPS_pubmethodAddExtension(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.)

System_CAPS_pubmethodAddExtension(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.)

System_CAPS_pubmethodAddExtension<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.)

System_CAPS_pubmethodCanDelete(Guid[])

Deletes the element from the model.(Defined by ImmutabilityExtensionMethods.)

System_CAPS_pubmethodGetAllExtensions()

Return an enumerable that performs a breadth first traversal across the tree of extension elements embedded in this ModelElement.(Defined by ModelElementExtensionMethods.)

System_CAPS_pubmethodGetBaseElement()

Returns the root of the virtual MEL in which the specified ModelElement is participating.(Defined by ModelElementExtensionMethods.)

System_CAPS_pubmethodGetDslDefinitionModelElement()

This method guarantees that the real model element corresponding to the PresentationElement is returned.

For DslDesigner PELs, the corresponding subject may actually be an internal TreeNode class and not the actual MEL.

This method handles those cases correctly so that the actual MEL is returned.(Defined by PresentationElementHelper.)

System_CAPS_pubmethodGetExtension(DomainClassInfo)

Overloaded. (Defined by ModelElementExtensionMethods.)

System_CAPS_pubmethodGetExtension(Guid)

Overloaded. (Defined by ModelElementExtensionMethods.)

System_CAPS_pubmethodGetExtension(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.)

System_CAPS_pubmethodGetExtension<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.)

System_CAPS_pubmethodGetLocks()

Overloaded. Get the lock flags for this element. This will include any locks enabled on the Partition containing the element.(Defined by ImmutabilityExtensionMethods.)

System_CAPS_pubmethodIsExtendedBy(DomainClassInfo)

Overloaded. Query whether this ModelElement is currently extended by an ExtensionElement of a particular type.(Defined by ModelElementExtensionMethods.)

System_CAPS_pubmethodIsExtendedBy(Guid)

Overloaded. Query whether this ModelElement is currently extended by an ExtensionElement of a particular type.(Defined by ModelElementExtensionMethods.)

System_CAPS_pubmethodIsExtendedBy(Type)

Overloaded. Query whether this ModelElement is currently extended by an ExtensionElement of a particular type.(Defined by ModelElementExtensionMethods.)

System_CAPS_pubmethodIsLocked(Locks)

Overloaded. Test whether this element has any of a specified set of locks(Defined by ImmutabilityExtensionMethods.)

System_CAPS_pubmethodRemoveExtension(DomainClassInfo)

Overloaded. Remove any extension of the specified ModelElement that is of a particular type.(Defined by ModelElementExtensionMethods.)

System_CAPS_pubmethodRemoveExtension(ExtensionElement)

Overloaded. Remove a specified ExtensionElement from the extensions of this ModelElement.(Defined by ModelElementExtensionMethods.)

System_CAPS_pubmethodRemoveExtension(Guid)

Overloaded. Remove any extension of the specified ModelElement that is of a particular type.(Defined by ModelElementExtensionMethods.)

System_CAPS_pubmethodRemoveExtension(Type)

Overloaded. Remove any extension of this ModelElement that is of a particular type.(Defined by ModelElementExtensionMethods.)

System_CAPS_pubmethodSetLocks(Locks)

Overloaded. Set the lock flags of this element(Defined by ImmutabilityExtensionMethods.)

System_CAPS_pubmethodTryGetExtension(DomainClassInfo)

Overloaded. (Defined by ModelElementExtensionMethods.)

System_CAPS_pubmethodTryGetExtension(Guid)

Overloaded. (Defined by ModelElementExtensionMethods.)

System_CAPS_pubmethodTryGetExtension(Type)

Overloaded. (Defined by ModelElementExtensionMethods.)

System_CAPS_pubmethodTryGetExtension<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.)

To navigate to the model element or relationship that the shape represents, use ModelElement.

Important subtypes include:

  • Diagram – represents a collection of shapes and connectors. The content of a Diagram is persisted in a .diagram file. If you specify a diagram class in your DSL Definition, it is derived from this class.

  • NodeShape – represents a shape that has a non-zero area, not a connector. If you specify shape classes in your DSL Definition, they are derived from NodeShape.

  • BinaryLinkShape – represents a line between two NodeShapes. If you specify connector classes in your DSL Definition, they are derived from this BinaryLinkShape.

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

Class diagram of base shape and element types

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: