Export (0) Print
Expand All

ShapeElement 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.

  NameDescription
Protected method ShapeElement Initializes a new instance of the ShapeElement class.
Top

  NameDescription
Public method AccessibleDoDefaultAction Performs the default action for the accessible object.
Public method Associate Assigns a model element to the presentation element. The same effect as setting ModelElement. (Inherited from PresentationElement.)
Public method Static member AssociateValueWith Overloaded. Associates the resource for the shape with an in-memory store property that is assigned to the shape.
Protected method CalculateDerivedVisible Verifies whether the child shape appears.
Protected method CanMerge Verifies whether a source element can be added to this element. (Inherited from ModelElement.)
Protected method ChooseMergeTarget Overloaded. Selects a target element that the root element should merge with.
Public method ChooseParentShape Selects a parent shape for a new child shape, typically this shape.
Protected method ChooseRelationship Selects which child list a new child shape should be added to – NestedChildShapes or RelativeChildShapes.
Public method CoerceSelection Allows a shape to determine which other shapes are selected.
Public method Copy Overloaded. Creates a copy of this element in the model.
Protected method CreateChildShape Creates a shape and adds it as a child to this shape.
Protected method CreateClassStyleSet Creates a class style set for the shape type.
Protected method CreateDecorators Creates a collection of decorators for the shape type.
Protected method CreateInstanceStyleSet Creates a style set for the shape.
Protected method CreateShapeFields Creates a collection of shape fields for the shape type.
Public method Delete Overloaded. Deletes the element from the model.
Protected method DetermineHighlightShape Finds the highlighted shape in a chain of shapes.
Public method DoFoldToShape Calculates the point where a connector will touch the perimeter of a shape. Override this if you define a non-rectangular shape.
Public method DoHitTest Overloaded. Returns true if a specified point is within the shape.
Public method DoHitTestSelection Returns true if a given point is in the selection handles around the shape.
Public method DoKeyboardNavigation Navigates the from shape to shape, using the keyboard.
Public method DrawResizeFeedback Draws the resizing feedback for the shape.
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Public method ExcludeFromClipRegion Excludes the shape and its child shapes from the clipping region.
Public method ExcludeGeometryFromClipRegion Excludes the geometry of a shape and its child shapes from the clipping region.
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method Static member FindDecorator Overloaded. Finds the shape decorator that has a given name.
Public method FindFirstChild Searches for the first child in the navigation sequence for the shape.
Public method FindFreeArea Finds an empty area on the grid for the shape.
Public method FindLastChild Searches for the last child in the navigation sequence for the shape.
Public method FindNextChild Searches for the next child in the navigation sequence for the shape.
Public method FindNextInChildFields Searches for the next shape field in the navigation sequence.
Public method FindPreviousChild Searches for the previous child in the navigation sequence for the shape.
Public method FindPreviousInChildFields Searches for the previous shape field in the navigation sequence.
Public method Static member FindShapeField Overloaded. Searches for a shape field in a shape.
Public method FixUpChildShapes Creates or adjusts the child shapes that should be created when a model element is created or updated. Called by Diagram.FixUpDiagram().
Public method Focused Verifies whether the shape has the focus.
Public method GetAccessibilityObject Gets the accessible object that is assigned to the shape.
Public method GetChildElements Gets a collection of child shapes that belong to the parent shape.
Public method GetCursor Gets the pointer that appears when the mouse is over the shape.
Public method GetDomainClass Gets the most-derived domain class for this element. (Inherited from ModelElement.)
Public method GetDragOverToolTipText Gets the tooltip text that appears when the mouse is over the shape.
Public method GetFieldAccessibleDescription Gets the description for a field in the shape.
Public method GetFieldAccessibleName Gets the name of a field in the shape.
Public method GetFieldAccessibleValue Gets the value for a field in the shape.
Public method GetFieldRepresentedElement Gets the primary element that the child shape represents.
Public method GetFieldRepresentedProperty Gets the property information for a field in the shape.
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetPotentialMouseAction Gets the mouse action to perform for a mouse down event over a specific point in the diagram.
Public method GetShapeLuminosity Calculates the luminosity of the shape.
Public method GetSubFieldAccessibleDescription Gets the description for a child field in the shape.
Public method GetSubFieldAccessibleName Gets the name of a child field in the shape.
Public method GetSubFieldAccessibleValue Gets the value for a child field in the shape.
Public method GetSubFieldRepresentedElements Gets a collection of elements that the shape for the child field represents.
Public method GetSubFieldRepresentedProperty Gets the property for the child field.
Public method GetSubFieldRepresentedPropertyElements Gets the element that contains the property for the child field.
Public method GetToolTipText Gets the tooltip text for the shape to which the mouse is pointing.
Public method GetType Gets the type of the current instance. (Inherited from Object.)
Protected method HasCachedDragOverResult Verifies whether the results are cached for the drag-over mouse event.
Public method Hide Hides the shape and all its children.
Protected method HideCustomToolTip Hides the custom tooltip for the shape.
Protected method InitializeDecorators Initializes and adds fields to the shape type.
Protected method InitializeInstanceResources Initializes the resources for an instance of the shape.
Protected method InitializeResources Initializes the resources for the shape.
Protected method 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.
Public method Invalidate Overloaded. Makes sure that the shape and its immediate surroundings will be repainted at the end of the transaction.
Public method IsDescendantOf Verifies whether the shape is a descendent of another shape.
Protected method IsNavigationKey Overloaded. Verifies whether the key is used for navigation in the shape.
Public method IterateShapes Iterates through a shape and its child shapes.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method MergeConfigure Not used for presentation elements. (Inherited from PresentationElement.)
Protected method MergeDisconnect Disconnects a source element from a target element. (Inherited from ModelElement.)
Protected method MergeRelate Creates a relationship between a model element and a group of model elements. (Inherited from PresentationElement.)
Protected method ModifyLuminosity Calculates the luminosity of the highlight for the shape.
Public method MoveByRepositioning Overloaded. Repositions the shapes in the group by the amount that the position of the mouse determines.
Public method NavigateAscend Navigates to the next ancestor in the navigation sequence and updates the focus. Called in response to user navigation keystrokes.
Public method NavigateDescend Navigates to the next descendent in the navigation sequence and updates the focus. Called in response to user navigation keystrokes.
Protected method NavigateTo Navigates to a specific shape in the navigation sequence and updates the focus.
Public method NavigateToFirst Navigates to the first shape in the navigation sequence in the parent of the current selection. Called in response to user navigation keystrokes.
Public method NavigateToLast Navigates to the last shape in the navigation sequence in the parent of the current selection. Called in response to user navigation keystrokes.
Public method NavigateToNext Navigates to the next shape in the navigation sequence. Called in response to user navigation keystrokes.
Public method NavigateToPrevious Navigates to the previously selected shape in the navigation sequence. Called in response to user navigation keystrokes.
Protected method OnAssociatedPropertyChanged Updates the shape when the value of an in-memory store property changes for a field in the shape.
Protected method OnBeforePaint Updates resources, such as pens and brushes, before they are used to paint the shape.
Public method OnBeginEdit Called when the user starts to edit a text field.
Public method 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.
Protected method OnChildConfigured Called when the positions and sizes of child shapes are about to be determined. Override to set specialized rules.
Protected method OnChildConfiguring Called after the size and position of a child shape has been determined.
Public method OnClick Called when the user clicks the shape.
Protected method OnCopy Alerts listeners that a copy of the element has been created. (Inherited from ModelElement.)
Protected method OnDeleted Alerts listeners that an element has been deleted from the model. (Inherited from ModelElement.)
Protected method OnDeleting Alerts listeners that the element is being deleted. (Inherited from ModelElement.)
Public method OnDoubleClick Called when the user double-clicks the shape.
Public method OnDragDrop Called when the user drags an item onto the shape.
Public method OnDragEnter Called when the mouse enters a shape during a drag operation.
Public method OnDragLeave Called when the mouse moves out of a shape.
Public method 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.
Public method OnEndEdit Called when the user ends editing a text field.
Public method OnInitialize Called to initialize the shape. Override this to attach event handlers and rules to this object.
Public method OnKeyDown Called when a key is pressed.
Public method OnKeyPress Called when a character is typed.
Public method OnKeyUp Called when a key is released.
Public method OnMouseDown Called when the user presses a mouse key.
Public method OnMouseEnter Called when the mouse enters a shape.
Public method OnMouseHover Called when the mouse hovers over a shape.
Public method OnMouseLeave Called when the mouse leaves a shape.
Public method OnMouseMove Called repeatedly when the user moves the mouse.
Public method OnMouseUp Called when a mouse button is released.
Public method OnMouseWheel Called when the user has rotated the mouse wheel.
Public method OnOrphaned Called when a
Public method OnPaintEmphasis Called when emphasis has been applied to the selected shape.
Public method OnPaintFeedback Called when drag-and-drop feedback is painted.
Public method OnPaintSelection Called to paint the selection highlight.
Public method OnPaintShape Called to paint the basic parts of the shape.
Protected method OnResurrected Alerts listeners that an element has been added back to a model. (Inherited from ModelElement.)
Protected method OnRolePlayerPositionChanged Alerts listeners that the position of a role is about to change. (Inherited from ModelElement.)
Protected method OnRolePlayerPositionChanging Allows notification when a role player position has changed. (Inherited from ModelElement.)
Public method OnShapeInserted Called when a shape has been inserted as a child of another.
Public method OnShapeRemoved Called when the shape has been removed as a child shape from its parent shape.
Public method PerformResizeParentRule Overloaded. Alerts the Domain-Specific Language Designer that a parent shape must be resized to match its child shapes.
Protected method PermitChildVisibility Verifies whether the child shape should appear in the diagram.
Protected method ProcessVisibilityChange Updates the visibility of the child shape when a change to visibility is made.
Public method PurgeLayoutObjects Removes the objects that are used to position the shape on the diagram grid.
Public method PurgePoints Removes points for the shape on the diagram grid.
Public method RebuildShape Rebuilds the shape.
Public method RemoveLayoutObject Removes the shape, including any relative and nested child shapes, from the diagram grid.
Public method Selected Verifies whether the shape is selected in a specified view.
Protected method SetInitialGraphLayoutVisibility Sets the visibility of the graph.
Public method SetShowHideState Sets the visibility of the shape and all its children.
Protected method SetShowHideStateImplementation Sets the visibility of the shape.
Protected method ShouldAddShapeForElement Determines whether a shape should be created to represent a given domain class instance on the diagram.
Public method ShouldReparentOnMove Verifies whether a child shape should be added to a new parent when the child shape is moved.
Public method Show Makes a shape and all its children visible.
Protected method ShowCustomToolTip Makes a shape's custom tooltip visible.
Public method ToString Gets the name of the shape and its type. (Overrides Object.ToString().)
Public method TranslateGeometryToAbsoluteBounds Converts the relative bounds to absolute bounds for the shape's geometry.
Public method TranslateGeometryToRelativeBounds Converts the absolute bounds to relative bounds for the shape's geometry.
Public method TranslateToAbsoluteBounds Converts the relative bounds to absolute bounds for the shape.
Public method TranslateToRelativeBounds Converts the absolute bounds to relative bounds for the shape.
Protected method UpdateDerivedVisible Updates the visible state of the derived shape.
Public method UpdateGeometryLuminosity Overloaded. Updates the luminosity for the pen or brush.
Top

  NameDescription
Public field Static member DomainClassId Represents the ID that is assigned to the shape.
Top

  NameDescription
Public property AbsoluteBoundingBox The bounding rectangle, measured relative to the Diagram.
Public property AbsoluteBoundingBoxToEnsureVisible Gets the absolute bounding rectangle for DiagramClientView.EnsureVisible.
Public property AbsoluteCenter Gets the point in the center of the shape.
Public property AccessibilityObject Gets the accessibility object for the shape.
Public property AccessibleDefaultActionDescription Gets the default action description for the shape.
Public property AccessibleDescription Gets the description for the shape.
Public property AccessibleHelp Gets the Help for the shape.
Public property AccessibleHelpTopicFileName Gets the Help topic for the shape.
Public property AccessibleHelpTopicId Gets the ID of the Help topic for the shape.
Public property AccessibleName Gets the name of the shape.
Public property AccessibleRole Gets the role of the shape.
Public property AccessibleState Gets the state of the shape.
Public property AccessibleValue Gets the value of the shape.
Public property AllowsChildrenInSelection If true, the children of this shape can be included in the current selection group.
Public property AllowsChildrenToResizeParent true if this shape can be resized when the size or position of a child shape is changed.
Public property AllowsChildrenToShrinkParent If true, this shape will reduce in size to fit around its children when they are re-sized or moved.
Public property BackgroundBrushId Gets the ID for the brush that is used to paint the background of the shape.
Public property BoundingBox The bounding rectangle, measured relative to the ParentShape.
Public property CanFocus Gets the shape and verifies whether it can receive the focus.
Public property CanMove Gets the shape and verifies whether a user can move it.
Public property CanSelect Gets the shape and verifies whether a user can select it.
Public property Center Gets the point in the center of the shape.
Protected property ClassStyleSet Gets the style set for the shape.
Public property ClipWhenDrawingFields Gets the child shape and verifies whether its clipping region should be set to the bounding box for the parent shape when the child shape is drawn.
Public property Decorators Gets the collection of decorators for the shape.
Public property DefaultShapeField Gets the default shape, which is the first shape that can receive focus.
Public property DefaultSize Gets the default size of the shape.
Public property Diagram Gets the diagram to which the shape belongs.
Protected property Events Gets the list of event handlers for the shape.
Public property GeometryBackgroundBrushId Gets the ID of the brush that is used to paint the background of the geometry.
Public property GeometryBoundingBox Gets the bounding box of the shape.
Public property GeometryHasFilledBackground Gets the shape and verifies whether its background is painted.
Public property GeometryHasOutline Gets the shape and verifies whether it has an outline.
Public property GeometryHasShadow true if the shape has a shadow; otherwise, false.
Public property GeometryOutlinePenId Gets the ID of the pen that draws the outline for the shape.
Public property GeometryStyleSet Gets the style set for the shape.
Public property GridSize If non-zero, this shape and its children will snap to a grid of this size. Defaults to ParentShape.GridSize.
Public property HasChildren true if the shape has child shapes.
Protected property HasCustomToolTip Gets the shape and verifies whether it has a custom tooltip.
Public property HasDragOverToolTip Gets the shape and verifies whether it has a tooltip.
Public property HasFilledBackground Gets the shape and verifies whether it has a background.
Public property HasHighlighting Gets the shape and verifies whether it is highlighted.
Public property HasOutline Gets the shape and verifies whether it has an outline.
Public property HasShadow Gets the shape and verifies whether it has a shadow.
Public property HasToolTip Gets the shape and verifies whether it has a tooltip.
Public property Id Gets the ID of the element. (Inherited from ModelElement.)
Public property IsActive Gets the IsActive flag and verifies to see whether the element is active. (Inherited from ModelElement.)
Public property IsDeleted Gets the IsDeleted flag and checks to see whether the element has been deleted from the model. (Inherited from ModelElement.)
Public property IsDeleting Gets the IsDeleting flag and verifies whether the element is currently being deleted from the model. (Inherited from ModelElement.)
Public property IsNestedChild true if this shape element is in the NestedChildShapes of its ParentShape.
Public property IsRelativeChild true if this shape element is in the RelativeChildShapes of its ParentShape.
Public property IsVisible If true, the shape appears on the diagram; if false, it does not appear, and layout and routing algorithms ignore it. See also Hide() and Show().
Public property LineAdjustAwayDefault Gets the shape and verifies whether child link shapes should try to align when they are connected to same shape or sets this value.
Public property LineAffinityDefault Gets or sets the target location where the link shape should try to position the shape.
Public property LineToLineClearance Gets or sets the distance between child link shapes for this shape.
Public property LineToNodeClearance Gets or sets the distance between child link shapes and child node shapes.
Public property Static member MaximumShadowOffset Gets the maximum offset for the shadow of the shape.
Public property MaximumSize Gets the maximum size for the shape.
Public property MinimumSize Gets the minimum size for the shape.
Public property ModelElement Gets or sets the model element that is associated with the presentation element. (Inherited from PresentationElement.)
Public property NestedChildShapes The list of shapes that are part of this shape, and are constrained to appear within the boundaries of this shape or diagram.
Public property NestedShapesMargin Gets the margin between the shape's bounding box and its nested node shapes.
Public property NodeToNodeClearance Gets or sets the margin between child node shapes.
Public property OutlinePenId Gets the ID of the pen that is used to draw the outline of the shape.
Public property OutlinePenWidth Gets the width of the outline for the shape.
Protected property ParentLink Gets the relationship instance from the shape to the parent shape.
Public property ParentShape Gets the parent shape element. To appear on a diagram, a shape or connector must have a parent.
Public property Partition Gets or sets the Partition that contains the element. (Inherited from ModelElement.)
Public property Perimeter Gets the perimeter (path) around the shape.
Public property RelatedShapeToEmphasize Gets the related shape to visually emphasize to the user when this shape is selected.
Public property RelativeChildShapes The list of shapes that are part of this shape, but can appear outside the boundaries of this shape.
Public property ShapeFields Parts of a shape such as text rows and decorators.
Public property ShapeGeometry Gets the geometry for the shape, such as Rectangle, RoundedRectangle, or Ellipse, which defines operations associated with the outline of the shape.
Public property ShouldTryParentShapeForMergeOnToolboxDoubleClick If true, when the user double-clicks a toolbox item with this shape selected, if the tool cannot be merged with this shape, then a merge with the parent shape will be attempted. Defaults to true.
Public property Store Gets the Store that contains the element. (Inherited from ModelElement.)
Public property StyleSet Gets an instance of the style set for the shape.
Public property Subject Gets or sets the subject for the presentation element. Defaults to the same object as ModelElement. (Inherited from PresentationElement.)
Public property TargetToolboxItemFilterAttributes Gets a collection of attributes that determine which items are enabled or disabled in the Toolbox.
Public property ZOrder Determines the order in which this shape will be displayed relative to other shapes on the diagram. Normally set from the order of child shapes.
Top

  NameDescription
Public event Click Occurs when the user clicks the mouse over a shape.
Public event DoubleClick Occurs when the user double-clicks the mouse.
Public event KeyDown Occurs when the user presses a key.
Public event KeyPress Occurs when the user presses and releases a key.
Public event KeyUp Occurs when the user releases a key.
Public event MouseDown Occurs when the user presses the mouse button.
Public event MouseMove Occurs when the user moves the mouse.
Public event MouseUp Occurs when the user releases the mouse button.
Public event MouseWheel Occurs when the user rotates the mouse wheel.
Top

Community Additions

ADD
Show:
© 2015 Microsoft