This documentation is archived and is not being maintained.

ShapeDecorator Class

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

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

public class ShapeDecorator : Decorator

The ShapeDecorator type exposes the following members.

  NameDescription
Public propertyCanMoveWhether 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 propertyDecoratorAnchorMarginsGets the margin around the field. The decorator can attach itself to the field in this area. (Inherited from Decorator.)
Public propertyFieldGets the field to which the decorator is assigned. (Inherited from Decorator.)
Public propertyOffsetGets or sets the offset that modifies the default position of the decorator. (Inherited from Decorator.)
Public propertyPositionGets or sets the position of this decorator relative to the parent shape.
Public propertyRequiresHostFor shapes, outer shape decorators require an additional host shape; inner decorators are implemented as shape fields on the shape itself. (Overrides Decorator.RequiresHost.)
Top

  NameDescription
Public methodAssociateValueWith(Store, AssociatedPropertyInfo)Associates the decorator with a store property that is assigned to the shape. (Inherited from Decorator.)
Public methodAssociateValueWith(Store, Guid)Associates the decorator with a store property that is assigned to the shape. (Inherited from Decorator.)
Public methodAssociateValueWith(Store, Guid, AssociatedPropertyInfo)Associates the decorator with a store property that is assigned to the shape. (Inherited from Decorator.)
Public methodAssociateVisibilityWith(Store, AssociatedPropertyInfo)Associates the visibility of the decorator with a store property that is assigned to a shape. (Inherited from Decorator.)
Public methodAssociateVisibilityWith(Store, Guid)Associates the visibility of the decorator with a store property that is assigned to a shape. (Inherited from Decorator.)
Public methodAssociateVisibilityWith(Store, Guid, AssociatedPropertyInfo)Associates the visibility of the decorator with a store property that is assigned to a shape. (Inherited from Decorator.)
Public methodConfigureHostShapeConfigures 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 methodEqualsDetermines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetHostShapeGets the host shape. (Inherited from Decorator.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetValueGets the association between the decorator and a shape. (Inherited from Decorator.)
Public methodGetVisibleGets the visibility of the decorator that is assigned to a shape. (Inherited from Decorator.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnAfterOffsetChangedShape decorators need to update anchoring after the offset changes. (Overrides Decorator.OnAfterOffsetChanged().)
Public methodRepositionHostShapeUpdates the position of the given host shape based on current decorator settings. (Overrides Decorator.RepositionHostShape(DecoratorHostShape).)
Public methodSetValueSets the association with the decoration and a shape. (Inherited from Decorator.)
Public methodSetVisibleSets the visibility of a decorator that is assigned to a shape. (Inherited from Decorator.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodUpdateDecoratorHostShapes(ModelElement)Updates the bounds for the host shapes. (Inherited from Decorator.)
Public methodUpdateDecoratorHostShapes(ModelElement, Guid)Updates the bounds for the host shapes. (Inherited from Decorator.)
Public methodUpdateHostShapeVisibilityUpdates the visibility of the host shape. (Inherited from Decorator.)
Top

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

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