Share via


Compartment Class

A compartment within a compartment shape.

Inheritance Hierarchy

Object
  Microsoft.VisualStudio.Modeling.ModelElement
    Microsoft.VisualStudio.Modeling.Diagrams.PresentationElement
      Microsoft.VisualStudio.Modeling.Diagrams.ShapeElement
        Microsoft.VisualStudio.Modeling.Diagrams.NodeShape
          Microsoft.VisualStudio.Modeling.Diagrams.Compartment
            Microsoft.VisualStudio.Modeling.Diagrams.ListCompartment

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

Syntax

'Declaration
<DomainModelOwnerAttribute(GetType(CoreDesignSurfaceDomainModel))> _
<DomainObjectIdAttribute("cf908511-03d6-4d10-b53a-dddc44d66a9a")> _
<DisplayNameResourceAttribute("Microsoft.VisualStudio.Modeling.Diagrams.Compartment.DisplayName",  _
    GetType(CoreDesignSurfaceDomainModel), "Microsoft.VisualStudio.Modeling.Diagrams.GeneratedCode.DomainModelResx")> _
<DescriptionResourceAttribute("Microsoft.VisualStudio.Modeling.Diagrams.Compartment.Description",  _
    GetType(CoreDesignSurfaceDomainModel), "Microsoft.VisualStudio.Modeling.Diagrams.GeneratedCode.DomainModelResx")> _
<CLSCompliantAttribute(True)> _
Public MustInherit Class Compartment _
    Inherits NodeShape
[DomainModelOwnerAttribute(typeof(CoreDesignSurfaceDomainModel))]
[DomainObjectIdAttribute("cf908511-03d6-4d10-b53a-dddc44d66a9a")]
[DisplayNameResourceAttribute("Microsoft.VisualStudio.Modeling.Diagrams.Compartment.DisplayName", 
    typeof(CoreDesignSurfaceDomainModel), "Microsoft.VisualStudio.Modeling.Diagrams.GeneratedCode.DomainModelResx")]
[DescriptionResourceAttribute("Microsoft.VisualStudio.Modeling.Diagrams.Compartment.Description", 
    typeof(CoreDesignSurfaceDomainModel), "Microsoft.VisualStudio.Modeling.Diagrams.GeneratedCode.DomainModelResx")]
[CLSCompliantAttribute(true)]
public abstract class Compartment : NodeShape
[DomainModelOwnerAttribute(typeof(CoreDesignSurfaceDomainModel))]
[DomainObjectIdAttribute(L"cf908511-03d6-4d10-b53a-dddc44d66a9a")]
[DisplayNameResourceAttribute(L"Microsoft.VisualStudio.Modeling.Diagrams.Compartment.DisplayName", 
    typeof(CoreDesignSurfaceDomainModel), L"Microsoft.VisualStudio.Modeling.Diagrams.GeneratedCode.DomainModelResx")]
[DescriptionResourceAttribute(L"Microsoft.VisualStudio.Modeling.Diagrams.Compartment.Description", 
    typeof(CoreDesignSurfaceDomainModel), L"Microsoft.VisualStudio.Modeling.Diagrams.GeneratedCode.DomainModelResx")]
[CLSCompliantAttribute(true)]
public ref class Compartment abstract : public NodeShape
[<AbstractClass>]
[<DomainModelOwnerAttribute(typeof(CoreDesignSurfaceDomainModel))>]
[<DomainObjectIdAttribute("cf908511-03d6-4d10-b53a-dddc44d66a9a")>]
[<DisplayNameResourceAttribute("Microsoft.VisualStudio.Modeling.Diagrams.Compartment.DisplayName", 
    typeof(CoreDesignSurfaceDomainModel), "Microsoft.VisualStudio.Modeling.Diagrams.GeneratedCode.DomainModelResx")>]
[<DescriptionResourceAttribute("Microsoft.VisualStudio.Modeling.Diagrams.Compartment.Description", 
    typeof(CoreDesignSurfaceDomainModel), "Microsoft.VisualStudio.Modeling.Diagrams.GeneratedCode.DomainModelResx")>]
[<CLSCompliantAttribute(true)>]
type Compartment =  
    class 
        inherit NodeShape 
    end
public abstract class Compartment extends NodeShape

The Compartment type exposes the following members.

Constructors

  Name Description
Protected method Compartment Initializes a new instance of the Compartment class.

Top

Properties

  Name Description
Public property AbsoluteBoundingBox The bounding rectangle of the shape, measured relative to the Diagram. (Inherited from NodeShape.)
Public property AbsoluteBoundingBoxToEnsureVisible Gets the absolute bounding rectangle for DiagramClientView.EnsureVisible. (Inherited from ShapeElement.)
Public property AbsoluteBounds A domain property that gets or sets the size and position of the bounding rectangle of the shape, measured relative to the top left of the diagram. (Inherited from NodeShape.)
Public property AbsoluteCenter Gets the point in the center of the shape. (Inherited from ShapeElement.)
Public property AccessibilityObject Gets the accessibility object for the shape. (Inherited from ShapeElement.)
Public property AccessibleDefaultActionDescription Gets the default action description for the shape. (Inherited from ShapeElement.)
Public property AccessibleDescription Gets the description for the shape. (Inherited from ShapeElement.)
Public property AccessibleHelp Gets the Help for the shape. (Inherited from ShapeElement.)
Public property AccessibleHelpTopicFileName Gets the Help topic for the shape. (Inherited from ShapeElement.)
Public property AccessibleHelpTopicId Gets the ID of the Help topic for the shape. (Inherited from ShapeElement.)
Public property AccessibleName Gets the name of the shape. (Inherited from ShapeElement.)
Public property AccessibleRole Gets the role of the shape. (Inherited from ShapeElement.)
Public property AccessibleState Gets the state of the shape. (Inherited from NodeShape.)
Public property AccessibleValue Gets the value of the shape. (Inherited from ShapeElement.)
Public property AllowCustomCompartmentFillColor Gets or sets permission to have a custom background color for the compartment shape.
Public property AllowCustomTitleFillColor Gets or sets permission to have a custom background color for the compartment title.
Public property AllowsChildrenInSelection If true, the children of this shape can be included in the current selection group. (Inherited from ShapeElement.)
Public property AllowsChildrenToResizeParent true if this shape can be resized when the size or position of a child shape is changed. (Inherited from ShapeElement.)
Public property AllowsChildrenToShrinkParent If true, this shape will reduce in size to fit around its children when they are re-sized or moved. (Inherited from ShapeElement.)
Public property Anchoring Describes how the shape should position and size itself as the parent shape moves and resizes. Alter the returned object as required. (Inherited from NodeShape.)
Public property AutoResizeParentOnBoundsChange Gets the child shape and verifies whether its parent shape should be resized when the absolute bounds for the child shape change. (Inherited from NodeShape.)
Public property BackgroundBrushId Gets the ID for the brush that is used to paint the background of the shape. (Inherited from ShapeElement.)
Public property BackgroundGradientMode Gets the gradient for the background of the shape. (Inherited from NodeShape.)
Public property BoundingBox Gets the bounding rectangle of the shape, measured relative to the ParentShape. (Inherited from NodeShape.)
Public property Bounds A domain property that gets or sets the size and position of the bounding rectangle of the shape, measured relative to the top left of the ParentShape. (Inherited from NodeShape.)
Public property BoundsRules Gets the boundaries for the compartment shape. (Overrides NodeShape.BoundsRules.)
Public property CanExpandAndCollapse Gets the compartment shape and verifies whether a user can collapse and expand it. (Overrides NodeShape.CanExpandAndCollapse.)
Public property CanFocus Gets the shape and verifies whether it can receive the focus. (Inherited from ShapeElement.)
Public property CanMove Gets the compartment shape and verifies whether a user can move it in the diagram. (Overrides ShapeElement.CanMove.)
Public property CanResize Gets the shape and verifies whether a user can resize it. (Inherited from NodeShape.)
Public property CanSelect Gets the shape and verifies whether a user can select it. (Inherited from ShapeElement.)
Public property Center Gets the point in the center of the shape. (Inherited from ShapeElement.)
Protected property ClassStyleSet Gets the style set for the shape. (Inherited from ShapeElement.)
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. (Inherited from ShapeElement.)
Protected property CollapsedSize Gets the size of the collapsed compartment shape.
Public property CompartmentFillColor Gets or sets the background color for the compartment shape.
Protected property CompartmentFillColorStorage Gets or sets the background color for the compartment shape by using a stored background color.
Public property ConnectionPoints A list of points on the perimeter of a shape at which connectors can terminate. By default, a shape has no connection points, and connectors can terminate anywhere on its perimeter. (Inherited from NodeShape.)
Public property Decorators Gets the collection of decorators for the shape. (Inherited from ShapeElement.)
Public property DefaultContainerMargin Gets the margin between the parent shape and its nested child shapes. (Inherited from NodeShape.)
Public property DefaultShapeField Gets the default shape, which is the first shape that can receive focus. (Inherited from ShapeElement.)
Public property DefaultSize Gets the default size of the shape. (Inherited from ShapeElement.)
Public property Diagram Gets the diagram to which the shape belongs. (Inherited from ShapeElement.)
Public property EnsureVisiblePreference Preferences for the EnsureVisible method for this Shape. Default value is to return the VisiblePreference for the Diagram hosting this Shape. (Inherited from ShapeElement.)
Protected property Events Gets the list of event handlers for the shape. (Inherited from ShapeElement.)
Protected property ExpandedSize Gets the size of the expanded compartment shape.
Public property FixedFlags Gets the flags that determine whether a shape is fixed to its position on the diagram. (Inherited from NodeShape.)
Public property ForwardEventsToParent Gets or sets permission to forward drag-and-drop, key, and mouse events from a child compartment shape to its parent compartment shape.
Public property FromRoleLinkShapes Gets the collection of link shapes for which this shape is the source. (Inherited from NodeShape.)
Public property GeometryBackgroundBrushId Gets the ID of the brush that is used to paint the background of the geometry. (Inherited from ShapeElement.)
Public property GeometryBoundingBox Gets the bounding box of the shape. (Inherited from ShapeElement.)
Public property GeometryCanResizeBottom Gets the shape and verifies whether the user can resize it vertically, starting at the bottom. (Inherited from NodeShape.)
Public property GeometryCanResizeLeft Gets the shape and verifies whether the user can resize it horizontally, starting on the left. (Inherited from NodeShape.)
Public property GeometryCanResizeRight Gets the shape and verifies whether the user can resize it horizontally, starting on the right. (Inherited from NodeShape.)
Public property GeometryCanResizeTop Gets the shape and verifies whether the user can resize it vertically, starting at the top. (Inherited from NodeShape.)
Public property GeometryHasFilledBackground Gets the shape and verifies whether its background is painted. (Inherited from ShapeElement.)
Public property GeometryHasOutline Gets the shape and verifies whether it has an outline. (Inherited from ShapeElement.)
Public property GeometryHasShadow true if the shape has a shadow; otherwise, false. (Inherited from ShapeElement.)
Public property GeometryOutlinePenId Gets the ID of the pen that draws the outline for the shape. (Inherited from ShapeElement.)
Public property GeometryStyleSet Gets the style set for the shape. (Inherited from ShapeElement.)
Public property GridSize If non-zero, this shape and its children will snap to a grid of this size. Defaults to ParentShape.GridSize. (Inherited from ShapeElement.)
Public property HasAnchoring True if there are any settings in the Anchoring. (Inherited from NodeShape.)
Public property HasBackgroundGradient Gets the shape and verifies whether it has a gradient for its background. (Inherited from NodeShape.)
Public property HasChildren true if the shape has child shapes. (Inherited from ShapeElement.)
Public property HasConnectionPoints True if the ConnectionPoints list is not empty. (Inherited from NodeShape.)
Protected property HasCustomToolTip Gets the shape and verifies whether it has a custom tooltip. (Inherited from ShapeElement.)
Public property HasDragOverToolTip Gets the shape and verifies whether it has a tooltip. (Inherited from ShapeElement.)
Public property HasFilledBackground Gets the shape and verifies whether it has a background. (Inherited from ShapeElement.)
Public property HasHighlighting Gets the compartment shape and verifies whether it is highlighted. (Overrides ShapeElement.HasHighlighting.)
Public property HasOutline Gets the compartment shape and verifies whether it has an outline around it. (Overrides ShapeElement.HasOutline.)
Public property HasShadow Gets the compartment shape and verifies whether it has a shadow behind it. (Overrides ShapeElement.HasShadow.)
Public property HasToolTip Gets the shape and verifies whether it has a tooltip. (Inherited from ShapeElement.)
Protected property HeaderBackgroundField Gets the background for the text area in the compartment shape header.
Public property HeaderBounds Gets the bounds for the compartment shape header.
Public property HeaderDisplayText Gets the text for the compartment shape header.
Protected property HeaderPlusMinusField Gets the expand/collapse chevron for the compartment shape.
Protected property HeaderTextField Gets the text field for the compartment shape header.
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 IsExpanded Gets the shape and verifies or sets whether it is expanded. (Inherited from NodeShape.)
Public property IsNestedChild true if this shape element is in the NestedChildShapes of its ParentShape. (Inherited from ShapeElement.)
Protected property IsPlaceRouteNode True if the shape’s position can be adjusted (Inherited from NodeShape.)
Public property IsPort true if the shape is a port shape; otherwise, false. (Inherited from NodeShape.)
Public property IsRelativeChild true if this shape element is in the RelativeChildShapes of its ParentShape. (Inherited from ShapeElement.)
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(). (Inherited from ShapeElement.)
Public property LayoutObjectFixedFlags Gets or sets the flags that determine whether a shape inside the graph is fixed to its position on the diagram. (Inherited from NodeShape.)
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. (Inherited from ShapeElement.)
Public property LineAffinityDefault Gets or sets the target location where the link shape should try to position the shape. (Inherited from ShapeElement.)
Public property LineToLineClearance Gets or sets the distance between child link shapes for this shape. (Inherited from ShapeElement.)
Public property LineToNodeClearance Gets or sets the distance between child link shapes and child node shapes. (Inherited from ShapeElement.)
Public property Link Gets a list of link shapes. (Inherited from NodeShape.)
Public property Location Gets or sets the coordinates of the top-left corner of the shape's bounds relative to its ParentShape. (Inherited from NodeShape.)
Public property MaximumSize Gets the maximum size for the shape. (Inherited from ShapeElement.)
Public property MinimumResizableSize Gets the minimum size to which the shape can be resized. (Inherited from NodeShape.)
Public property MinimumSize Gets the minimum width and height for the compartment shape. (Overrides NodeShape.MinimumSize.)
Public property ModelElement Gets or sets the model element that is associated with the presentation element. (Inherited from PresentationElement.)
Public property Name Gets or sets the name of the compartment shape.
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. (Inherited from ShapeElement.)
Public property NestedShapesMargin Gets the margin between the shape's bounding box and its nested node shapes. (Inherited from ShapeElement.)
Public property NodeToNodeClearance Gets or sets the margin between child node shapes. (Inherited from ShapeElement.)
Public property OutlinePenId Gets the ID of the pen that is used to draw the outline of the shape. (Inherited from ShapeElement.)
Public property OutlinePenWidth Gets the width of the outline for the shape. (Inherited from ShapeElement.)
Protected property PaintMoveableDecoratorSelectionLines (Inherited from ShapeElement.)
Protected property ParentLink Gets the relationship instance from the shape to the parent shape. (Inherited from ShapeElement.)
Public property ParentShape Gets the parent shape element. To appear on a diagram, a shape or connector must have a parent. (Inherited from ShapeElement.)
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. (Inherited from ShapeElement.)
Public property PortFixedFlags Gets the flags that determine whether a port shape is fixed to its position. (Inherited from NodeShape.)
Public property RelatedShapeToEmphasize Gets the related shape to visually emphasize to the user when this shape is selected. (Inherited from ShapeElement.)
Public property RelativeChildShapes The list of shapes that are part of this shape, but can appear outside the boundaries of this shape. (Inherited from ShapeElement.)
Public property ResizableSides Gets the sides of the shape that the user can resize. (Overrides NodeShape.ResizableSides.)
Public property ShapeFields Parts of a shape such as text rows and decorators. (Inherited from ShapeElement.)
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. (Inherited from ShapeElement.)
Public property ShouldAutoPlaceChildShapes Gets a shape and verifies whether its nested child shapes should be automatically positioned on the diagram. (Inherited from NodeShape.)
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. (Inherited from ShapeElement.)
Public property Size Gets or sets the size of the shape. (Inherited from NodeShape.)
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. (Inherited from ShapeElement.)
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. (Inherited from ShapeElement.)
Public property Title Gets or sets the title for the compartment shape.
Public property TitleFillColor Gets or sets the background color for the compartment shape title.
Protected property TitleFillColorStorage Gets or sets the background color for the compartment shape title by using a stored background color.
Public property TitleTextColor Gets or sets the value of TitleTextColor domain property. Description for Microsoft.VisualStudio.Modeling.Diagrams.Compartment.Title Text Color
Public property TitleVisibility Gets the compartment shape and verifies whether the title appears on it.
Public property ToRoleLinkShapes Gets the collection of link shapes for which this shape is the target. (Inherited from NodeShape.)
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. (Inherited from ShapeElement.)

Top

Methods

  Name Description
Public method AccessibleDoDefaultAction Performs the default action for the accessible object. (Inherited from ShapeElement.)
Public method Associate Assigns a model element to the presentation element. The same effect as setting ModelElement. (Inherited from PresentationElement.)
Public method AutoLayoutChildShapes Positions the collection of shapes in the diagram automatically. (Inherited from NodeShape.)
Protected method CalculateDerivedVisible Verifies whether the child shape appears. (Inherited from ShapeElement.)
Public method CalculateMinimumSizeBasedOnChildren Calculates the minimum size needed so that the shape can include its child shapes. (Inherited from NodeShape.)
Protected method CanMerge Verifies whether a source element can be added to this element. (Inherited from ModelElement.)
Protected method ChooseMergeTarget(ElementGroup) Selects a target element to accept as its child an element that the user wants to copy, drag, or create. (Inherited from ModelElement.)
Protected method ChooseMergeTarget(ElementGroupPrototype) Selects a target element to accept as its child an element that the user wants to copy, drag, or create. (Inherited from ModelElement.)
Public method ChooseParentShape Selects a parent shape for a new child shape, typically this shape. (Inherited from ShapeElement.)
Protected method ChooseRelationship Called by FixUpChildShapes() to get the relationship to create between the child shape and its parent shape. (Inherited from NodeShape.)
Public method CoerceSelection Allows a shape to determine which other shapes are selected. (Inherited from ShapeElement.)
Protected method Collapse Collapses the compartment shape so that only the compartment header appears. (Overrides NodeShape.Collapse().)
Protected method ConfiguredChildPortShape Configures a child port shape and positions it, if necessary. (Inherited from NodeShape.)
Public method Copy() Creates a copy of the element in the model. (Inherited from ModelElement.)
Public method Copy(IEnumerable<Guid>) Creates a copy of the element and its child links and elements. (Inherited from ModelElement.)
Protected method CreateBackgroundGradientField Creates the area field, which displays the gradient fill in the background of the shape. (Inherited from NodeShape.)
Protected method CreateChildShape Creates a shape and adds it as a child to this shape. (Inherited from ShapeElement.)
Protected method CreateClassStyleSet Creates a class style set for the shape type. (Inherited from ShapeElement.)
Public method CreateConnectionPoint A connection point is a point on the edge of a shape at which connectors are terminated in preference to other points on the edge. (Inherited from NodeShape.)
Protected method CreateDecorators Creates a collection of decorators for the shape type. (Inherited from ShapeElement.)
Public method CreateDefaultBounds Creates default bounding rectangle for the shape. (Inherited from NodeShape.)
Protected method CreateInstanceStyleSet Creates a style set for the shape. (Inherited from ShapeElement.)
Protected method CreateShapeFields Creates a collection of shape fields for the shape type. (Inherited from ShapeElement.)
Public method Delete() Deletes an element from the model. (Inherited from ModelElement.)
Public method Delete(array<Guid[]) Deletes an element from the model. (Inherited from ModelElement.)
Protected method DetermineHighlightShape Finds the highlighted shape in a chain of shapes. (Inherited from ShapeElement.)
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. (Inherited from ShapeElement.)
Public method DoHitTest(PointD, DiagramHitTestInfo) Returns true if the specified point is within the shape. (Inherited from ShapeElement.)
Public method DoHitTest(PointD, DiagramHitTestInfo, Boolean) Returns true if the specified point is within the shape. (Inherited from ShapeElement.)
Public method DoHitTestSelection Returns true if a given point is in the selection handles around the shape. (Inherited from ShapeElement.)
Public method DoKeyboardNavigation Navigates the from shape to shape, using the keyboard. (Inherited from ShapeElement.)
Public method DrawResizeFeedback Draws the resizing feedback for the shape. (Inherited from ShapeElement.)
Public method EnsureConnectionPoints Override to set points on the edge of the shape at which connectors should terminate. (Inherited from NodeShape.)
Protected method EnsureGraphExists Verifies whether the grid exists for the shape. (Inherited from NodeShape.)
Protected method EnsureGraphLayoutObjectsExist Verifies whether the shape and its child shapes are in the graph wrapper. (Inherited from NodeShape.)
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. (Inherited from ShapeElement.)
Public method ExcludeGeometryFromClipRegion Excludes the geometry of a shape and its child shapes from the clipping region. (Inherited from ShapeElement.)
Protected method ExcludeShapeFromSizeCalculation If true the shape will not be taken into account to calculate the size of the parent shape (Inherited from NodeShape.)
Protected method Expand Expands the compartment shape so that both the compartment header and body appear. (Overrides NodeShape.Expand().)
Protected method ExpandAll Expands the compartment shape and all the compartments in it.
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 FindDecorator(String) Finds the shape decorator that has a given name. (Inherited from ShapeElement.)
Public method FindFirstChild Searches for the first child in the navigation sequence for the shape. (Inherited from ShapeElement.)
Public method FindFreeArea(RectangleD) Finds an empty area on the grid for the shape. (Inherited from NodeShape.)
Public method FindFreeArea(Double, Double, Double, Double, Double, Double, Double, Double, Double, Double, Double, Double) Finds an empty area on the grid for the shape. (Inherited from ShapeElement.)
Public method FindLastChild Searches for the last child in the navigation sequence for the shape. (Inherited from ShapeElement.)
Public method FindNextChild Searches for the next child in the navigation sequence for the shape. (Inherited from ShapeElement.)
Public method FindNextInChildFields Searches for the next shape field in the navigation sequence. (Inherited from ShapeElement.)
Public method FindPreviousChild Searches for the previous child in the navigation sequence for the shape. (Inherited from ShapeElement.)
Public method FindPreviousInChildFields Searches for the previous shape field in the navigation sequence. (Inherited from ShapeElement.)
Public method FindShapeField(String) Searches for a shape field in a shape. (Inherited from ShapeElement.)
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(). (Inherited from ShapeElement.)
Public method Focused Verifies whether the shape has the focus. (Inherited from ShapeElement.)
Protected method GetAbsoluteBoundsValue Gets the absolute bounds for the shape. (Inherited from NodeShape.)
Public method GetAccessibilityObject Gets the accessible object that is assigned to the shape. (Inherited from ShapeElement.)
Public method GetChildElements Gets a collection of child shapes that belong to the parent shape. (Inherited from ShapeElement.)
Public method GetCompliantAnchorPoint Calculates compliant AnchorPoint based of the proposedAnchorPoint parameter. This method completely ignores the co-ordinates of the anchorPoint parameter. Calculations are done based on the co-ordinates of the proposedAnchorPoint and the anchorPoint at opposite end of the link corresponding to the anchorPoint parameter. (Inherited from NodeShape.)
Public method GetCursor Gets the pointer that appears when the mouse is over the shape. (Inherited from ShapeElement.)
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. (Inherited from ShapeElement.)
Public method GetFieldAccessibleDescription Gets the description for a field in the shape. (Inherited from ShapeElement.)
Public method GetFieldAccessibleName Gets the name of a field in the shape. (Inherited from ShapeElement.)
Public method GetFieldAccessibleValue Gets the value for a field in the shape. (Inherited from ShapeElement.)
Public method GetFieldRepresentedElement Gets the primary element that the child shape represents. (Inherited from ShapeElement.)
Public method GetFieldRepresentedProperty Gets the property information for a field in the shape. (Inherited from ShapeElement.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Protected method GetIsExpandedValue Gets the value for the IsExpanded property. (Inherited from NodeShape.)
Public method GetPotentialMouseAction Gets the mouse action to perform for a mouse down event over a specific point in the diagram. (Inherited from ShapeElement.)
Protected method GetRoleCollection<TCollection, TElement>(Guid) Gets or creates the linked element collection (Inherited from ModelElement.)
Public method GetShapeLuminosity Calculates the luminosity of the shape. (Inherited from ShapeElement.)
Public method GetSubFieldAccessibleDescription Gets the description for a child field in the shape. (Inherited from ShapeElement.)
Public method GetSubFieldAccessibleName Gets the name of a child field in the shape. (Inherited from ShapeElement.)
Public method GetSubFieldAccessibleValue Gets the value for a child field in the shape. (Inherited from ShapeElement.)
Public method GetSubFieldRepresentedElements Gets a collection of elements that the shape for the child field represents. (Inherited from ShapeElement.)
Public method GetSubFieldRepresentedProperty Gets the property for the child field. (Inherited from ShapeElement.)
Public method GetSubFieldRepresentedPropertyElements Gets the element that contains the property for the child field. (Inherited from ShapeElement.)
Public method GetToolTipText Gets the tooltip text for the shape to which the mouse is pointing. (Inherited from ShapeElement.)
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. (Inherited from ShapeElement.)
Public method Hide Hides the shape and all its children. (Inherited from ShapeElement.)
Protected method HideCustomToolTip Hides the custom tooltip for the shape. (Inherited from ShapeElement.)
Protected method InitializeDecorators Initializes and adds fields to the shape type. (Inherited from ShapeElement.)
Public method InitializeFromDescription Initializes the description for the compartment shape.
Protected method InitializeInstanceResources Initializes the resources for an instance of the shape. (Inherited from ShapeElement.)
Protected method InitializeResources Initializes the style of the compartment shape. (Overrides ShapeElement.InitializeResources(StyleSet).)
Protected method InitializeShapeFields Initializes the header of the compartment shape. (Overrides NodeShape.InitializeShapeFields(IList<ShapeField>).)
Public method Invalidate() Makes sure that the shape and its immediate surroundings will be repainted at the end of the transaction. (Inherited from ShapeElement.)
Public method Invalidate(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. (Inherited from ShapeElement.)
Public method Invalidate(RectangleD) Makes sure that the shape and its old location will be repainted at the end of the transaction. (Inherited from ShapeElement.)
Public method IsDescendantOf Verifies whether the shape is a descendent of another shape. (Inherited from ShapeElement.)
Protected method IsNavigationKey(Char) Verifies whether the key is used as a navigational command. (Inherited from ShapeElement.)
Protected method IsNavigationKey(Keys) Verifies whether the key data is used as a navigational command. (Inherited from ShapeElement.)
Public method IterateShapes Iterates through a shape and its child shapes. (Inherited from ShapeElement.)
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. (Inherited from ShapeElement.)
Protected method MoveByRepositioning(DiagramDragEventArgs) Repositions the shapes in the group by the amount that the position of the mouse determines. (Inherited from ShapeElement.)
Public method MoveByRepositioning(ElementGroupPrototype, DiagramItemCollection, PointD, DiagramItem) Repositions the shapes in the group by the amount that the position of the mouse determines. (Inherited from ShapeElement.)
Public method NavigateAcrossLinks Selects the shapes or sets the focus on the shapes that are connected to this shape. (Inherited from NodeShape.)
Public method NavigateAscend Navigates to the next ancestor in the navigation sequence and updates the focus. Called in response to user navigation keystrokes. (Inherited from ShapeElement.)
Public method NavigateDescend Navigates to the next descendent in the navigation sequence and updates the focus. Called in response to user navigation keystrokes. (Inherited from ShapeElement.)
Protected method NavigateTo Navigates to a specific shape in the navigation sequence and updates the focus. (Inherited from ShapeElement.)
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. (Inherited from ShapeElement.)
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. (Inherited from ShapeElement.)
Public method NavigateToNext Navigates to the next shape in the navigation sequence. Called in response to user navigation keystrokes. (Inherited from ShapeElement.)
Public method NavigateToPrevious Navigates to the previously selected shape in the navigation sequence. Called in response to user navigation keystrokes. (Inherited from ShapeElement.)
Public method OnAbsoluteBoundsChanged Called when the size or location of the shape have changed. (Inherited from NodeShape.)
Protected method OnAssociatedPropertyChanged Updates the shape when the value of an in-memory store property changes for a field in the shape. (Inherited from ShapeElement.)
Protected method OnBeforePaint Updates resources, such as pens and brushes, before they are used to paint the shape. (Inherited from ShapeElement.)
Public method OnBeginEdit Called when the user starts to edit a text field. (Inherited from ShapeElement.)
Public method OnBoundsFixup Override this method to customize how the bounds for the shape are determined. (Inherited from NodeShape.)
Protected method OnChildConfigured Configures a port on the shape after the shape is added to the diagram. (Inherited from NodeShape.)
Protected method OnChildConfiguring Configures the port on the shape when the shape is being added to the diagram. (Inherited from NodeShape.)
Public method OnClick Forwards the event to the compartment shape when the user clicks the compartment. (Overrides ShapeElement.OnClick(DiagramPointEventArgs).)
Protected method OnCopy Called when this element has been created as a copy of another element. (Inherited from ModelElement.)
Protected method OnDeleted Called when this element has been deleted from the model. (Inherited from ModelElement.)
Protected method OnDeleting Called when this element is about to be deleted. (Inherited from ModelElement.)
Public method OnDoubleClick Forwards the event to the compartment shape when the user double-clicks the compartment. (Overrides ShapeElement.OnDoubleClick(DiagramPointEventArgs).)
Public method OnDragDrop Forwards the event to the compartment shape when the user drags the compartment to another location. (Overrides ShapeElement.OnDragDrop(DiagramDragEventArgs).)
Public method OnDragEnter Called when the mouse enters a shape during a drag operation. (Inherited from ShapeElement.)
Public method OnDragLeave Called when the mouse moves out of a shape. (Inherited from ShapeElement.)
Public method OnDragOver Forwards the event to the compartment shape when the user drags the mouse over the compartment. (Overrides ShapeElement.OnDragOver(DiagramDragEventArgs).)
Public method OnEndEdit Called when the user ends editing a text field. (Inherited from ShapeElement.)
Public method OnInitialize Called to initialize the shape. Override this to attach event handlers and rules to this object. (Inherited from ShapeElement.)
Public method OnKeyDown Forwards the event to the compartment shape when the user holds a key down. (Overrides NodeShape.OnKeyDown(DiagramKeyEventArgs).)
Public method OnKeyPress Forwards the event to the compartment shape when the user presses a key. (Overrides NodeShape.OnKeyPress(DiagramKeyPressEventArgs).)
Public method OnKeyUp Forwards the event to the compartment shape when the user releases a key. (Overrides ShapeElement.OnKeyUp(DiagramKeyEventArgs).)
Public method OnMouseDown Forwards the event to the compartment shape when the user holds down the mouse button over the compartment. (Overrides ShapeElement.OnMouseDown(DiagramMouseEventArgs).)
Public method OnMouseEnter Called when the mouse enters a shape. (Inherited from ShapeElement.)
Public method OnMouseHover Called when the mouse hovers over a shape. (Inherited from ShapeElement.)
Public method OnMouseLeave Called when the mouse leaves a shape. (Inherited from ShapeElement.)
Public method OnMouseMove Called repeatedly when the user moves the mouse. (Inherited from ShapeElement.)
Public method OnMouseUp Forwards the event to the compartment shape when the user releases the mouse button when pointing to the compartment. (Overrides ShapeElement.OnMouseUp(DiagramMouseEventArgs).)
Public method OnMouseWheel Called when the user has rotated the mouse wheel. (Inherited from ShapeElement.)
Public method OnOrphaned Called when a (Inherited from ShapeElement.)
Public method OnPaintEmphasis Called when emphasis has been applied to the selected shape. (Inherited from ShapeElement.)
Public method OnPaintFeedback Called when drag-and-drop feedback is painted. (Inherited from ShapeElement.)
Public method OnPaintSelection Forwards the event to the compartment shape when the user changes the style of the compartment. (Overrides ShapeElement.OnPaintSelection(DiagramPaintEventArgs).)
Public method OnPaintShape Called to paint the basic parts of the shape. (Inherited from ShapeElement.)
Protected method OnParentNodeShapeChanged This method is invoked if a) ParentShape is NodeShape b) ParentShape either moved or resized. (Inherited from NodeShape.)
Protected method OnResurrected Called when this element has been added back to a model. (Inherited from ModelElement.)
Protected method OnRolePlayerPositionChanged Called when the position of a role has changed. (Inherited from ModelElement.)
Protected method OnRolePlayerPositionChanging Called when a role player position is about to change. (Inherited from ModelElement.)
Public method OnShapeInserted Called when a shape has been inserted as a child of another. (Inherited from ShapeElement.)
Public method OnShapeRemoved Called when the shape has been removed as a child shape from its parent shape. (Inherited from ShapeElement.)
Protected method OverrideStyles Set the shape's styles into the given styleset
Public method PerformResizeParentRule() Alerts the Domain-Specific Language Designer that a parent shape must be resized to match its child shapes. (Inherited from ShapeElement.)
Public method PerformResizeParentRule(Boolean, ShapeElement) Alerts the Domain-Specific Language Designer that a parent shape must be resized to match its child shapes. (Inherited from ShapeElement.)
Public method PerformShapeAnchoringRule Anchors the shape to the diagram. (Inherited from NodeShape.)
Protected method PermitChildVisibility Verifies whether the child shape can appear. (Inherited from NodeShape.)
Protected method ProcessVisibilityChange Processes a shape's change in visibility. (Inherited from NodeShape.)
Public method PurgeLayoutObjects Removes the objects that are used to position the shape on the diagram grid. (Inherited from ShapeElement.)
Public method PurgePoints Removes points for the shape on the diagram grid. (Inherited from ShapeElement.)
Public method RebuildShape Rebuilds the shape. (Inherited from ShapeElement.)
Public method RemoveLayoutObject Removes the shape, including any relative and nested child shapes, from the diagram grid. (Inherited from ShapeElement.)
Public method Selected Verifies whether the shape is selected in a specified view. (Inherited from ShapeElement.)
Protected method SetAbsoluteBoundsValue Sets the value for the AbsoluteBounds property. (Inherited from NodeShape.)
Protected method SetInitialGraphLayoutVisibility Sets the visibility of the graph. (Inherited from ShapeElement.)
Protected method SetIsExpandedValue Sets the value for the IsExpanded property. (Inherited from NodeShape.)
Public method SetShowHideState Sets the visibility of the shape and all its children. (Inherited from ShapeElement.)
Protected method SetShowHideStateImplementation Sets the visibility of the shape. (Inherited from ShapeElement.)
Protected method ShouldAddShapeForElement Determines whether a shape should be created to represent a given domain class instance on the diagram. (Inherited from ShapeElement.)
Public method ShouldReparentOnMove Verifies whether a child shape should be added to a new parent when the child shape is moved. (Inherited from ShapeElement.)
Public method Show Makes a shape and all its children visible. (Inherited from ShapeElement.)
Protected method ShowCustomToolTip Makes a shape's custom tooltip visible. (Inherited from ShapeElement.)
Public method Side Assigns a side of the shape to the port. (Inherited from NodeShape.)
Public method ToString Gets the name of the shape and its type. (Inherited from ShapeElement.)
Public method TranslateGeometryToAbsoluteBounds Converts the relative bounds to absolute bounds for the shape's geometry. (Inherited from ShapeElement.)
Public method TranslateGeometryToRelativeBounds Converts the absolute bounds to relative bounds for the shape's geometry. (Inherited from ShapeElement.)
Public method TranslateToAbsoluteBounds Converts the relative bounds to absolute bounds for the shape. (Inherited from ShapeElement.)
Public method TranslateToRelativeBounds Converts the absolute bounds to relative bounds for the shape. (Inherited from ShapeElement.)
Protected method UpdateChildVisibility Updates the visibility status for the child shape. (Inherited from NodeShape.)
Protected method UpdateDerivedVisible Updates the visible state of the derived shape. (Inherited from ShapeElement.)
Public method UpdateGeometryLuminosity(DiagramClientView, Brush) Updates the luminosity for the brush. (Inherited from ShapeElement.)
Public method UpdateGeometryLuminosity(DiagramClientView, Pen) Updates the luminosity for the pen. (Inherited from ShapeElement.)
Public method UpdateSize Updates the height and width of the compartment.

Top

Events

  Name Description
Public event AbsoluteBoundsChanged Occurs when the absolute bounds for the shape change. (Inherited from NodeShape.)
Public event Click Occurs when the user clicks the mouse over a shape. (Inherited from ShapeElement.)
Public event DoubleClick Occurs when the user double-clicks the mouse. (Inherited from ShapeElement.)
Public event KeyDown Occurs when the user presses a key. (Inherited from ShapeElement.)
Public event KeyPress Occurs when the user presses and releases a key. (Inherited from ShapeElement.)
Public event KeyUp Occurs when the user releases a key. (Inherited from ShapeElement.)
Public event MouseDown Occurs when the user presses the mouse button. (Inherited from ShapeElement.)
Public event MouseMove Occurs when the user moves the mouse. (Inherited from ShapeElement.)
Public event MouseUp Occurs when the user releases the mouse button. (Inherited from ShapeElement.)
Public event MouseWheel Occurs when the user rotates the mouse wheel. (Inherited from ShapeElement.)

Top

Extension Methods

  Name Description
Public Extension Method AddExtension(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.)
Public Extension Method AddExtension(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.)
Public Extension Method AddExtension(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.)
Public Extension Method AddExtension(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.)
Public Extension Method AddExtension<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.)
Public Extension Method CanDelete Deletes the element from the model. (Defined by ImmutabilityExtensionMethods.)
Public Extension Method GetAllExtensions Return an enumerable that performs a breadth first traversal across the tree of extension elements embedded in this ModelElement. (Defined by ModelElementExtensionMethods.)
Public Extension Method GetBaseElement Returns the root of the virtual MEL in which the specified ModelElement is participating. (Defined by ModelElementExtensionMethods.)
Public Extension Method 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.)
Public Extension Method GetExtension(Guid) Overloaded. (Defined by ModelElementExtensionMethods.)
Public Extension Method GetExtension(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.)
Public Extension Method GetExtension(DomainClassInfo) Overloaded. (Defined by ModelElementExtensionMethods.)
Public Extension Method GetExtension<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.)
Public Extension Method GetLocks Get the lock flags for this element. This will include any locks enabled on the Partition containing the element. (Defined by ImmutabilityExtensionMethods.)
Public Extension Method IsExtendedBy(Guid) Overloaded. Query whether this ModelElement is currently extended by an ExtensionElement of a particular type. (Defined by ModelElementExtensionMethods.)
Public Extension Method IsExtendedBy(Type) Overloaded. Query whether this ModelElement is currently extended by an ExtensionElement of a particular type. (Defined by ModelElementExtensionMethods.)
Public Extension Method IsExtendedBy(DomainClassInfo) Overloaded. Query whether this ModelElement is currently extended by an ExtensionElement of a particular type. (Defined by ModelElementExtensionMethods.)
Public Extension Method IsLocked Test whether this element has any of a specified set of locks (Defined by ImmutabilityExtensionMethods.)
Public Extension Method RemoveExtension(Type) Overloaded. Remove any extension of this ModelElement that is of a particular type. (Defined by ModelElementExtensionMethods.)
Public Extension Method RemoveExtension(Guid) Overloaded. Remove any extension of the specified ModelElement that is of a particular type. (Defined by ModelElementExtensionMethods.)
Public Extension Method RemoveExtension(DomainClassInfo) Overloaded. Remove any extension of the specified ModelElement that is of a particular type. (Defined by ModelElementExtensionMethods.)
Public Extension Method RemoveExtension(ExtensionElement) Overloaded. Remove a specified ExtensionElement from the extensions of this ModelElement. (Defined by ModelElementExtensionMethods.)
Public Extension Method SetLocks Set the lock flags of this element (Defined by ImmutabilityExtensionMethods.)
Public Extension Method TryGetExtension(Guid) Overloaded. (Defined by ModelElementExtensionMethods.)
Public Extension Method TryGetExtension(Type) Overloaded. (Defined by ModelElementExtensionMethods.)
Public Extension Method TryGetExtension(DomainClassInfo) Overloaded. (Defined by ModelElementExtensionMethods.)
Public Extension Method TryGetExtension<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.)

Top

Fields

  Name Description
Public fieldStatic member CompartmentFillColorDomainPropertyId Represents the ID that is assigned to the compartment shape background color.
Public fieldStatic member DomainClassId Represents the ID that is assigned to the compartment shape.
Public fieldStatic member NameDomainPropertyId Represents the ID that is assigned to the name of the compartment shape.
Public fieldStatic member TitleDomainPropertyId Represents the ID that is assigned to the title of the compartment shape.
Public fieldStatic member TitleFillColorDomainPropertyId Represents the ID that is assigned to the background of the compartment shape title.
Public fieldStatic member TitleTextColorDomainPropertyId TitleTextColor domain property Id.
Public fieldStatic member TitleVisibilityDomainPropertyId Represents the ID that is assigned to the visibility state of the compartment shape title.

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IMergeElements.CanMerge Returns true if this element can merge with the content of the prototype. (Inherited from ModelElement.)
Explicit interface implemetationPrivate method IMergeElements.ChooseMergeTarget(ElementGroup) (Inherited from ModelElement.)
Explicit interface implemetationPrivate method IMergeElements.ChooseMergeTarget(ElementGroupPrototype) (Inherited from ModelElement.)
Explicit interface implemetationPrivate method IMergeElements.MergeConfigure (Inherited from ModelElement.)
Explicit interface implemetationPrivate method IMergeElements.MergeDisconnect (Inherited from ModelElement.)
Explicit interface implemetationPrivate method IMergeElements.MergeRelate (Inherited from ModelElement.)

Top

Remarks

Each compartment has a header, which might or might not be visible, and a set of fields representing the rows.

Thread Safety

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

See Also

Reference

Microsoft.VisualStudio.Modeling.Diagrams Namespace