ShapeElement Properties

Include Protected Members
Include Inherited Members

The ShapeElement type exposes the following members.

Properties

 

Name

Description

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 propertyStatic 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

See Also

Reference

ShapeElement Class

Microsoft.VisualStudio.Modeling.Diagrams Namespace