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
[DisplayNameResourceAttribute("Microsoft.VisualStudio.Modeling.Diagrams.ShapeElement.DisplayName", 
	(CoreDesignSurfaceDomainModel^::typeid), "Microsoft.VisualStudio.Modeling.Diagrams.GeneratedCode.DomainModelResx")]
[DescriptionResourceAttribute("Microsoft.VisualStudio.Modeling.Diagrams.ShapeElement.Description", 
	(CoreDesignSurfaceDomainModel^::typeid), "Microsoft.VisualStudio.Modeling.Diagrams.GeneratedCode.DomainModelResx")]
[DomainModelOwnerAttribute((CoreDesignSurfaceDomainModel^::typeid))]
[CLSCompliantAttribute(true)]
[DomainObjectIdAttribute("ffb3d9f5-7a47-4e12-8501-0055bd018825")]
public ref class ShapeElement abstract : PresentationElement, 
	IGeometryHost
[<AbstractClass>]
[<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")>]
type ShapeElement = 
    class
        inherit PresentationElement
        interface IGeometryHost
    end
<DisplayNameResourceAttribute("Microsoft.VisualStudio.Modeling.Diagrams.ShapeElement.DisplayName",
	GetType(CoreDesignSurfaceDomainModel), "Microsoft.VisualStudio.Modeling.Diagrams.GeneratedCode.DomainModelResx")>
<DescriptionResourceAttribute("Microsoft.VisualStudio.Modeling.Diagrams.ShapeElement.Description",
	GetType(CoreDesignSurfaceDomainModel), "Microsoft.VisualStudio.Modeling.Diagrams.GeneratedCode.DomainModelResx")>
<DomainModelOwnerAttribute(GetType(CoreDesignSurfaceDomainModel))>
<CLSCompliantAttribute(True)>
<DomainObjectIdAttribute("ffb3d9f5-7a47-4e12-8501-0055bd018825")>
Public MustInherit Class ShapeElement
	Inherits PresentationElement
	Implements IGeometryHost
NameDescription
System_CAPS_protmethod ShapeElement

Initializes a new instance of the ShapeElement class.

NameDescription
System_CAPS_pubproperty

The bounding rectangle, measured relative to the Diagram.

System_CAPS_pubproperty

Gets the absolute bounding rectangle for DiagramClientViewEnsureVisible.

System_CAPS_pubproperty

Gets the point in the center of the shape.

System_CAPS_pubproperty

Gets the accessibility object for the shape.

System_CAPS_pubproperty

Gets the default action description for the shape.

System_CAPS_pubproperty

Gets the description for the shape.

System_CAPS_pubproperty

Gets the Help for the shape.

System_CAPS_pubproperty

Gets the Help topic for the shape.

System_CAPS_pubproperty

Gets the ID of the Help topic for the shape.

System_CAPS_pubproperty

Gets the name of the shape.

System_CAPS_pubproperty

Gets the role of the shape.

System_CAPS_pubproperty

Gets the state of the shape.

System_CAPS_pubproperty

Gets the value of the shape.

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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

System_CAPS_pubproperty

The bounding rectangle, measured relative to the ParentShape.

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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

System_CAPS_pubproperty

Gets the point in the center of the shape.

System_CAPS_protproperty

Gets the style set for the shape.

System_CAPS_pubproperty

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_pubproperty

Gets the collection of decorators for the shape.

System_CAPS_pubproperty

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

System_CAPS_pubproperty

Gets the default size of the shape.

System_CAPS_pubproperty

Gets the diagram to which the shape belongs.

System_CAPS_pubproperty

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

System_CAPS_protproperty

Gets the list of event handlers for the shape.

System_CAPS_pubproperty

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

System_CAPS_pubproperty

Gets the bounding box of the shape.

System_CAPS_pubproperty

Gets the shape and verifies whether its background is painted.

System_CAPS_pubproperty

Gets the shape and verifies whether it has an outline.

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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

System_CAPS_pubproperty

Gets the style set for the shape.

System_CAPS_pubproperty

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

System_CAPS_pubproperty

true if the shape has child shapes.

System_CAPS_protproperty

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

System_CAPS_pubproperty

Gets the shape and verifies whether it has a tooltip.

System_CAPS_pubproperty

Gets the shape and verifies whether it has a background.

System_CAPS_pubproperty

Gets the shape and verifies whether it is highlighted.

System_CAPS_pubproperty

Gets the shape and verifies whether it has an outline.

System_CAPS_pubproperty

Gets the shape and verifies whether it has a shadow.

System_CAPS_pubproperty

Gets the shape and verifies whether it has a tooltip.

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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

System_CAPS_pubproperty

true if this shape element is in the of its .

System_CAPS_pubproperty

true if this shape element is in the of its .

System_CAPS_pubproperty

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_pubproperty

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_pubproperty

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

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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

System_CAPS_pubproperty System_CAPS_static

Gets the maximum offset for the shadow of the shape.

System_CAPS_pubproperty

Gets the maximum size for the shape.

System_CAPS_pubproperty

Gets the minimum size for the shape.

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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_pubproperty

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

System_CAPS_pubproperty

Gets or sets the margin between child node shapes.

System_CAPS_pubproperty

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

System_CAPS_pubproperty

Gets the width of the outline for the shape.

System_CAPS_protproperty

System_CAPS_protproperty

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

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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

System_CAPS_pubproperty

Gets the perimeter (path) around the shape.

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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

System_CAPS_pubproperty

Parts of a shape such as text rows and decorators.

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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_pubproperty

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

System_CAPS_pubproperty

Gets an instance of the style set for the shape.

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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_pubmethod AccessibleDoDefaultAction

Performs the default action for the accessible object.

System_CAPS_pubmethod Associate

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

System_CAPS_pubmethod System_CAPS_static AssociateValueWith

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

System_CAPS_pubmethod System_CAPS_static AssociateValueWith

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

System_CAPS_protmethod CalculateDerivedVisible

Verifies whether the child shape appears.

System_CAPS_protmethod CanMerge

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

System_CAPS_protmethod ChooseMergeTarget

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_protmethod ChooseMergeTarget

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_pubmethod ChooseParentShape

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

System_CAPS_protmethod ChooseRelationship

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

System_CAPS_pubmethod CoerceSelection

Allows a shape to determine which other shapes are selected.

System_CAPS_pubmethod Copy

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

System_CAPS_pubmethod Copy

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

System_CAPS_protmethod CreateChildShape

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

System_CAPS_protmethod CreateClassStyleSet

Creates a class style set for the shape type.

System_CAPS_protmethod CreateDecorators

Creates a collection of decorators for the shape type.

System_CAPS_protmethod CreateInstanceStyleSet

Creates a style set for the shape.

System_CAPS_protmethod CreateShapeFields

Creates a collection of shape fields for the shape type.

System_CAPS_pubmethod Delete

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

System_CAPS_pubmethod Delete

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

System_CAPS_protmethod DetermineHighlightShape

Finds the highlighted shape in a chain of shapes.

System_CAPS_pubmethod DoFoldToShape

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

System_CAPS_pubmethod DoHitTest

Returns true if the specified point is within the shape.

System_CAPS_pubmethod DoHitTest

Returns true if the specified point is within the shape.

System_CAPS_pubmethod DoHitTestSelection

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

System_CAPS_pubmethod DoKeyboardNavigation

Navigates the from shape to shape, using the keyboard.

System_CAPS_pubmethod DrawResizeFeedback

Draws the resizing feedback for the shape.

System_CAPS_pubmethod Equals

(Inherited from Object.)

System_CAPS_pubmethod ExcludeFromClipRegion

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

System_CAPS_pubmethod ExcludeGeometryFromClipRegion

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

System_CAPS_protmethod Finalize

(Inherited from Object.)

System_CAPS_pubmethod System_CAPS_static FindDecorator

Finds the shape decorator that has a given name.

System_CAPS_pubmethod FindDecorator

Finds the shape decorator that has a given name.

System_CAPS_pubmethod FindFirstChild

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

System_CAPS_pubmethod FindFreeArea

Finds an empty area on the grid for the shape.

System_CAPS_pubmethod FindLastChild

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

System_CAPS_pubmethod FindNextChild

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

System_CAPS_pubmethod FindNextInChildFields

Searches for the next shape field in the navigation sequence.

System_CAPS_pubmethod FindPreviousChild

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

System_CAPS_pubmethod FindPreviousInChildFields

Searches for the previous shape field in the navigation sequence.

System_CAPS_pubmethod System_CAPS_static FindShapeField

Searches for a shape field in a shape.

System_CAPS_pubmethod FindShapeField

Searches for a shape field in a shape.

System_CAPS_pubmethod FixUpChildShapes

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

System_CAPS_pubmethod Focused

Verifies whether the shape has the focus.

System_CAPS_pubmethod GetAccessibilityObject

Gets the accessible object that is assigned to the shape.

System_CAPS_pubmethod GetChildElements

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

System_CAPS_pubmethod GetCursor

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

System_CAPS_pubmethod GetDomainClass

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

System_CAPS_pubmethod GetDragOverToolTipText

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

System_CAPS_pubmethod GetFieldAccessibleDescription

Gets the description for a field in the shape.

System_CAPS_pubmethod GetFieldAccessibleName

Gets the name of a field in the shape.

System_CAPS_pubmethod GetFieldAccessibleValue

Gets the value for a field in the shape.

System_CAPS_pubmethod GetFieldRepresentedElement

Gets the primary element that the child shape represents.

System_CAPS_pubmethod GetFieldRepresentedProperty

Gets the property information for a field in the shape.

System_CAPS_pubmethod GetHashCode

(Inherited from Object.)

System_CAPS_pubmethod GetPotentialMouseAction

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

System_CAPS_protmethod GetRoleCollection

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

System_CAPS_pubmethod GetShapeLuminosity

Calculates the luminosity of the shape.

System_CAPS_pubmethod GetSubFieldAccessibleDescription

Gets the description for a child field in the shape.

System_CAPS_pubmethod GetSubFieldAccessibleName

Gets the name of a child field in the shape.

System_CAPS_pubmethod GetSubFieldAccessibleValue

Gets the value for a child field in the shape.

System_CAPS_pubmethod GetSubFieldRepresentedElements

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

System_CAPS_pubmethod GetSubFieldRepresentedProperty

Gets the property for the child field.

System_CAPS_pubmethod GetSubFieldRepresentedPropertyElements

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

System_CAPS_pubmethod GetToolTipText

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

System_CAPS_pubmethod GetType

(Inherited from Object.)

System_CAPS_protmethod HasCachedDragOverResult

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

System_CAPS_pubmethod Hide

Hides the shape and all its children.

System_CAPS_protmethod HideCustomToolTip

Hides the custom tooltip for the shape.

System_CAPS_protmethod InitializeDecorators

Initializes and adds fields to the shape type.

System_CAPS_protmethod InitializeInstanceResources

Initializes the resources for an instance of the shape.

System_CAPS_protmethod InitializeResources

Initializes the resources for the shape.

System_CAPS_protmethod InitializeShapeFields

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_pubmethod Invalidate

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

System_CAPS_pubmethod Invalidate

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_pubmethod Invalidate

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

System_CAPS_pubmethod IsDescendantOf

Verifies whether the shape is a descendent of another shape.

System_CAPS_protmethod IsNavigationKey

Verifies whether the key is used as a navigational command.

System_CAPS_protmethod IsNavigationKey

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

System_CAPS_pubmethod IterateShapes

Iterates through a shape and its child shapes.

System_CAPS_protmethod MemberwiseClone

(Inherited from Object.)

System_CAPS_protmethod MergeConfigure

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

System_CAPS_protmethod MergeDisconnect

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

System_CAPS_protmethod MergeRelate

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

System_CAPS_protmethod ModifyLuminosity

Calculates the luminosity of the highlight for the shape.

System_CAPS_protmethod MoveByRepositioning

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

System_CAPS_pubmethod MoveByRepositioning

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

System_CAPS_pubmethod NavigateAscend

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

System_CAPS_pubmethod NavigateDescend

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

System_CAPS_protmethod NavigateTo

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

System_CAPS_pubmethod NavigateToFirst

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_pubmethod NavigateToLast

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_pubmethod NavigateToNext

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

System_CAPS_pubmethod NavigateToPrevious

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

System_CAPS_protmethod OnAssociatedPropertyChanged

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

System_CAPS_protmethod OnBeforePaint

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

System_CAPS_pubmethod OnBeginEdit

Called when the user starts to edit a text field.

System_CAPS_pubmethod OnBoundsFixup

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_protmethod OnChildConfigured

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

System_CAPS_protmethod OnChildConfiguring

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

System_CAPS_pubmethod OnClick

Called when the user clicks the shape.

System_CAPS_protmethod OnCopy

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

System_CAPS_protmethod OnDeleted

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

System_CAPS_protmethod OnDeleting

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

System_CAPS_pubmethod OnDoubleClick

Called when the user double-clicks the shape.

System_CAPS_pubmethod OnDragDrop

Called when the user drags an item onto the shape.

System_CAPS_pubmethod OnDragEnter

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

System_CAPS_pubmethod OnDragLeave

Called when the mouse moves out of a shape.

System_CAPS_pubmethod OnDragOver

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_pubmethod OnEndEdit

Called when the user ends editing a text field.

System_CAPS_pubmethod OnInitialize

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

System_CAPS_pubmethod OnKeyDown

Called when a key is pressed.

System_CAPS_pubmethod OnKeyPress

Called when a character is typed.

System_CAPS_pubmethod OnKeyUp

Called when a key is released.

System_CAPS_pubmethod OnMouseDown

Called when the user presses a mouse key.

System_CAPS_pubmethod OnMouseEnter

Called when the mouse enters a shape.

System_CAPS_pubmethod OnMouseHover

Called when the mouse hovers over a shape.

System_CAPS_pubmethod OnMouseLeave

Called when the mouse leaves a shape.

System_CAPS_pubmethod OnMouseMove

Called repeatedly when the user moves the mouse.

System_CAPS_pubmethod OnMouseUp

Called when a mouse button is released.

System_CAPS_pubmethod OnMouseWheel

Called when the user has rotated the mouse wheel.

System_CAPS_pubmethod OnOrphaned

Called when a

System_CAPS_pubmethod OnPaintEmphasis

Called when emphasis has been applied to the selected shape.

System_CAPS_pubmethod OnPaintFeedback

Called when drag-and-drop feedback is painted.

System_CAPS_pubmethod OnPaintSelection

Called to paint the selection highlight.

System_CAPS_pubmethod OnPaintShape

Called to paint the basic parts of the shape.

System_CAPS_protmethod OnResurrected

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

System_CAPS_protmethod OnRolePlayerPositionChanged

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

System_CAPS_protmethod OnRolePlayerPositionChanging

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

System_CAPS_pubmethod OnShapeInserted

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

System_CAPS_pubmethod OnShapeRemoved

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

System_CAPS_pubmethod PerformResizeParentRule

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

System_CAPS_pubmethod PerformResizeParentRule

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

System_CAPS_protmethod PermitChildVisibility

Verifies whether the child shape should appear in the diagram.

System_CAPS_protmethod ProcessVisibilityChange

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

System_CAPS_pubmethod PurgeLayoutObjects

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

System_CAPS_pubmethod PurgePoints

Removes points for the shape on the diagram grid.

System_CAPS_pubmethod RebuildShape

Rebuilds the shape.

System_CAPS_pubmethod RemoveLayoutObject

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

System_CAPS_pubmethod Selected

Verifies whether the shape is selected in a specified view.

System_CAPS_protmethod SetInitialGraphLayoutVisibility

Sets the visibility of the graph.

System_CAPS_pubmethod SetShowHideState

Sets the visibility of the shape and all its children.

System_CAPS_protmethod SetShowHideStateImplementation

Sets the visibility of the shape.

System_CAPS_protmethod ShouldAddShapeForElement

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

System_CAPS_pubmethod ShouldReparentOnMove

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

System_CAPS_pubmethod Show

Makes a shape and all its children visible.

System_CAPS_protmethod ShowCustomToolTip

Makes a shape's custom tooltip visible.

System_CAPS_pubmethod ToString

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

System_CAPS_pubmethod TranslateGeometryToAbsoluteBounds

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

System_CAPS_pubmethod TranslateGeometryToRelativeBounds

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

System_CAPS_pubmethod TranslateToAbsoluteBounds

Converts the relative bounds to absolute bounds for the shape.

System_CAPS_pubmethod TranslateToRelativeBounds

Converts the absolute bounds to relative bounds for the shape.

System_CAPS_protmethod UpdateDerivedVisible

Updates the visible state of the derived shape.

System_CAPS_pubmethod UpdateGeometryLuminosity

Updates the luminosity for the brush.

System_CAPS_pubmethod UpdateGeometryLuminosity

Updates the luminosity for the pen.

NameDescription
System_CAPS_pubfield System_CAPS_static DomainClassId

Represents the ID that is assigned to the shape.

NameDescription
System_CAPS_pubevent Click

Occurs when the user clicks the mouse over a shape.

System_CAPS_pubevent DoubleClick

Occurs when the user double-clicks the mouse.

System_CAPS_pubevent KeyDown

Occurs when the user presses a key.

System_CAPS_pubevent KeyPress

Occurs when the user presses and releases a key.

System_CAPS_pubevent KeyUp

Occurs when the user releases a key.

System_CAPS_pubevent MouseDown

Occurs when the user presses the mouse button.

System_CAPS_pubevent MouseMove

Occurs when the user moves the mouse.

System_CAPS_pubevent MouseUp

Occurs when the user releases the mouse button.

System_CAPS_pubevent MouseWheel

Occurs when the user rotates the mouse wheel.

NameDescription
System_CAPS_pubinterface System_CAPS_privmethod IMergeElementsCanMerge

Returns true if this element can merge with the content of the prototype.(Inherited from ModelElement.)

System_CAPS_pubinterface System_CAPS_privmethod IMergeElementsChooseMergeTarget

(Inherited from ModelElement.)

System_CAPS_pubinterface System_CAPS_privmethod IMergeElementsChooseMergeTarget

(Inherited from ModelElement.)

System_CAPS_pubinterface System_CAPS_privmethod IMergeElementsMergeConfigure

(Inherited from ModelElement.)

System_CAPS_pubinterface System_CAPS_privmethod IMergeElementsMergeDisconnect

(Inherited from ModelElement.)

System_CAPS_pubinterface System_CAPS_privmethod IMergeElementsMergeRelate

(Inherited from ModelElement.)

NameDescription
System_CAPS_pubmethod AddExtension

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_pubmethod AddExtension

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_pubmethod AddExtension

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_pubmethod AddExtension

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_pubmethod AddExtension

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_pubmethod CanDelete

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

System_CAPS_pubmethod GetAllExtensions

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

System_CAPS_pubmethod GetBaseElement

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

System_CAPS_pubmethod GetDslDefinitionModelElement

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_pubmethod GetExtension

Overloaded. (Defined by ModelElementExtensionMethods.)

System_CAPS_pubmethod GetExtension

Overloaded. (Defined by ModelElementExtensionMethods.)

System_CAPS_pubmethod GetExtension

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_pubmethod GetExtension

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_pubmethod GetLocks

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_pubmethod IsExtendedBy

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

System_CAPS_pubmethod IsExtendedBy

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

System_CAPS_pubmethod IsExtendedBy

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

System_CAPS_pubmethod IsLocked

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

System_CAPS_pubmethod RemoveExtension

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

System_CAPS_pubmethod RemoveExtension

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

System_CAPS_pubmethod RemoveExtension

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

System_CAPS_pubmethod RemoveExtension

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

System_CAPS_pubmethod SetLocks

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

System_CAPS_pubmethod TryGetExtension

Overloaded. (Defined by ModelElementExtensionMethods.)

System_CAPS_pubmethod TryGetExtension

Overloaded. (Defined by ModelElementExtensionMethods.)

System_CAPS_pubmethod TryGetExtension

Overloaded. (Defined by ModelElementExtensionMethods.)

System_CAPS_pubmethod TryGetExtension

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 .

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