ShapeDecorator Class

  • Article

Class to encapsulate the way ShapeFields and child shapes are used to represent Notation Decorators when they are placed on a Shape

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Modeling.Diagrams.Decorator
    Microsoft.VisualStudio.Modeling.Diagrams.ShapeDecorator
      Microsoft.VisualStudio.Modeling.Diagrams.ExpandCollapseDecorator

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

Syntax

'Declaration
Public Class ShapeDecorator _
    Inherits Decorator

public class ShapeDecorator : Decorator

public ref class ShapeDecorator : public Decorator

type ShapeDecorator =  
    class
        inherit Decorator
    end

public class ShapeDecorator extends Decorator

The ShapeDecorator type exposes the following members.

Constructors

  Name Description
Public method ShapeDecorator(ShapeField, ShapeDecoratorPosition) Construct a new ShapeDecorator.
Public method ShapeDecorator(ShapeField, ShapeDecoratorPosition, PointD) Construct a new ShapeDecorator.
Public method ShapeDecorator(ShapeField, ShapeDecoratorPosition, Boolean) Construct a new ShapeDecorator.
Public method ShapeDecorator(ShapeField, ShapeDecoratorPosition, PointD, Boolean) Construct a new ShapeDecorator.

Top

Properties

  Name Description
Public property CanMove Whether this decorator can be moved. A decorator can be moved only if it is instantiated as moveable and also requires a host. (Inherited from Decorator.)
Protected property DecoratorAnchorMargins Gets the margin around the field. The decorator can attach itself to the field in this area. (Inherited from Decorator.)
Public property Field Gets the field to which the decorator is assigned. (Inherited from Decorator.)
Public property Offset Gets or sets the offset that modifies the default position of the decorator. (Inherited from Decorator.)
Public property Position Gets or sets the position of this decorator relative to the parent shape.
Public property RequiresHost For shapes, outer shape decorators require an additional host shape; inner decorators are implemented as shape fields on the shape itself. (Overrides Decorator.RequiresHost.)

Top

Methods

  Name Description
Public method AssociateValueWith(Store, AssociatedPropertyInfo) Associates the decorator with a store property that is assigned to the shape. (Inherited from Decorator.)
Public method AssociateValueWith(Store, Guid) Associates the decorator with a store property that is assigned to the shape. (Inherited from Decorator.)
Public method AssociateValueWith(Store, Guid, AssociatedPropertyInfo) Associates the decorator with a store property that is assigned to the shape. (Inherited from Decorator.)
Public method AssociateVisibilityWith(Store, AssociatedPropertyInfo) Associates the visibility of the decorator with a store property that is assigned to a shape. (Inherited from Decorator.)
Public method AssociateVisibilityWith(Store, Guid) Associates the visibility of the decorator with a store property that is assigned to a shape. (Inherited from Decorator.)
Public method AssociateVisibilityWith(Store, Guid, AssociatedPropertyInfo) Associates the visibility of the decorator with a store property that is assigned to a shape. (Inherited from Decorator.)
Public method ConfigureHostShape Configures a host shape for use with this decorator. If the given parent does not have a host shape for this decorator, a new one will be created. If a host shape already exists, settings for this decorator will be re-applied to the existing host shape; a new host shape will not be created. (Overrides Decorator.ConfigureHostShape(ShapeElement).)
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
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 GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetHostShape Gets the host shape. (Inherited from Decorator.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method GetValue Gets the association between the decorator and a shape. (Inherited from Decorator.)
Public method GetVisible Gets the visibility of the decorator that is assigned to a shape. (Inherited from Decorator.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnAfterOffsetChanged Shape decorators need to update anchoring after the offset changes. (Overrides Decorator.OnAfterOffsetChanged().)
Public method RepositionHostShape Updates the position of the given host shape based on current decorator settings. (Overrides Decorator.RepositionHostShape(DecoratorHostShape).)
Public method SetValue Sets the association with the decoration and a shape. (Inherited from Decorator.)
Public method SetVisible Sets the visibility of a decorator that is assigned to a shape. (Inherited from Decorator.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method UpdateDecoratorHostShapes(ModelElement) Updates the bounds for the host shapes. (Inherited from Decorator.)
Public method UpdateDecoratorHostShapes(ModelElement, Guid) Updates the bounds for the host shapes. (Inherited from Decorator.)
Public method UpdateHostShapeVisibility Updates the visibility of the host shape. (Inherited from Decorator.)

Top

Remarks

Inner shapes are simple ShapeFields, whereas Outer shapes require host shapes

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

ShapeField