Shape Class
DomainClass Shape Abstract base class for geometry and compartment shapes.
Inheritance Hierarchy
System.Object
Microsoft.VisualStudio.Modeling.ModelElement
Microsoft.VisualStudio.Modeling.DslDefinition.DomainElement
Microsoft.VisualStudio.Modeling.DslDefinition.AttributedDomainElement
Microsoft.VisualStudio.Modeling.DslDefinition.NamedDomainElement
Microsoft.VisualStudio.Modeling.DslDefinition.DomainClass
Microsoft.VisualStudio.Modeling.DslDefinition.DiagramElement
Microsoft.VisualStudio.Modeling.DslDefinition.BaseShape
Microsoft.VisualStudio.Modeling.DslDefinition.Shape
More...
Namespace: Microsoft.VisualStudio.Modeling.DslDefinition
Assembly: Microsoft.VisualStudio.Modeling.Sdk.DslDefinition.12.0 (in Microsoft.VisualStudio.Modeling.Sdk.DslDefinition.12.0.dll)
Syntax
'Declaration
<DisplayNameResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.Shape.DisplayName", _
GetType(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")> _
<DescriptionResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.Shape.Description", _
GetType(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")> _
<DomainModelOwnerAttribute(GetType(DslDefinitionModelDomainModel))> _
<CLSCompliantAttribute(True)> _
<DomainObjectIdAttribute("f1f25ea6-bdf9-4b35-9dec-59395fba0810")> _
<ValidationStateAttribute(ValidationState.Enabled)> _
Public MustInherit Class Shape _
Inherits BaseShape
[DisplayNameResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.Shape.DisplayName",
typeof(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[DescriptionResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.Shape.Description",
typeof(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[DomainModelOwnerAttribute(typeof(DslDefinitionModelDomainModel))]
[CLSCompliantAttribute(true)]
[DomainObjectIdAttribute("f1f25ea6-bdf9-4b35-9dec-59395fba0810")]
[ValidationStateAttribute(ValidationState.Enabled)]
public abstract class Shape : BaseShape
[DisplayNameResourceAttribute(L"Microsoft.VisualStudio.Modeling.DslDefinition.Shape.DisplayName",
typeof(DslDefinitionModelDomainModel), L"Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[DescriptionResourceAttribute(L"Microsoft.VisualStudio.Modeling.DslDefinition.Shape.Description",
typeof(DslDefinitionModelDomainModel), L"Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[DomainModelOwnerAttribute(typeof(DslDefinitionModelDomainModel))]
[CLSCompliantAttribute(true)]
[DomainObjectIdAttribute(L"f1f25ea6-bdf9-4b35-9dec-59395fba0810")]
[ValidationStateAttribute(ValidationState::Enabled)]
public ref class Shape abstract : public BaseShape
[<AbstractClass>]
[<DisplayNameResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.Shape.DisplayName",
typeof(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")>]
[<DescriptionResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.Shape.Description",
typeof(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")>]
[<DomainModelOwnerAttribute(typeof(DslDefinitionModelDomainModel))>]
[<CLSCompliantAttribute(true)>]
[<DomainObjectIdAttribute("f1f25ea6-bdf9-4b35-9dec-59395fba0810")>]
[<ValidationStateAttribute(ValidationState.Enabled)>]
type Shape =
class
inherit BaseShape
end
public abstract class Shape extends BaseShape
The Shape type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Protected method") |
Shape | Constructor. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
AccessModifier | Gets or sets the value of AccessModifier domain property. Determines if the access modifier for the domain class is public or internal. (Inherited from DomainClass.) |
|
AllDescendants | Gets a read-only list of all domain classes directly or indirectly derived from this one. (Inherited from DomainClass.) |
|
AllProperties | The set of all DomainProperties both defined on this class and inherited from base classes. (Inherited from DomainClass.) |
|
AllRolesPlayed | The set of all DomainRoles both played directly by this class and inherited from base classes. (Inherited from DomainClass.) |
|
Attributes | Gets a list of Attributes. (Inherited from AttributedDomainElement.) |
|
BaseClass | Gets or sets the base class of this domain class. (Inherited from DomainClass.) |
|
ClassData | Gets or sets ClassData. Xml serialization configuration data for the domain class. (Inherited from DomainClass.) |
|
CustomAttributes | Gets or sets the value of CustomAttributes domain property. Used to attribute the code generated from this element. (Inherited from AttributedDomainElement.) |
|
CustomTypeDescriptor | Gets or sets CustomTypeDescriptor. Definition of the custom type descriptor for the class. (Inherited from DomainClass.) |
|
Decorators | Gets a list of Decorators. Decorators for the diagram element. (Inherited from DiagramElement.) |
|
Description | Gets or sets the value of Description domain property. Used in the UI and in the code documentation of the generated designer. (Inherited from AttributedDomainElement.) |
|
DisplayName | Gets or sets the value of DisplayName domain property. The name that will be displayed in the generated designer for this element. (Inherited from NamedDomainElement.) |
|
DslLibrary | Gets or sets DslLibrary. Dsl library defining the shape. (Inherited from BaseShape.) |
|
ElementMergeDirectives | Gets a list of ElementMergeDirectives. (Inherited from DomainClass.) |
|
ExposesFillColorAsProperty | Gets or sets the value of ExposesFillColorAsProperty domain property. If True, a domain property has been added to the shape to allow the fill color to be exposed in the properties window of the generated designer. |
|
ExposesFillGradientMode | Gets or sets the value of ExposesFillGradientMode domain property. If True, a domain property has been added to the shape to allow the fill gradient mode to be exposed in the properties window of the generated designer. |
|
ExposesOutlineColorAsProperty | Gets or sets the value of ExposesOutlineColorAsProperty domain property. If True, a domain property has been added to the shape to allow the outline color to be exposed in the properties window of the generated designer. |
|
ExposesOutlineDashStyleAsProperty | Gets or sets the value of ExposesOutlineDashStyleAsProperty domain property. If True, a domain property has been added to the shape to allow the outline dash style to be exposed in the properties window of the generated designer. |
|
ExposesOutlineThicknessAsProperty | Gets or sets the value of ExposesOutlineThicknessAsProperty domain property. If True, a domain property has been added to the shape to allow the outline thickness to be exposed in the properties window of the generated designer. |
|
ExposesTextColor | Gets or sets the value of ExposesTextColor domain property. If True, a domain property has been added to the connector to allow the text color to be exposed in the properties window of the generated designer. (Inherited from DiagramElement.) |
|
FillColor | Gets or sets the value of FillColor domain property. Fill color of this shape. |
|
FillGradientMode | Gets or sets the value of FillGradientMode domain property. Fill gradient mode of this shape. |
|
FixedTooltipText | Gets or sets the value of FixedTooltipText domain property. Text used for a fixed tooltip. (Inherited from DiagramElement.) |
|
GeneratesDoubleDerived | Gets or sets the value of GeneratesDoubleDerived domain property. If True, will generate both a base class with all functionality and a partial class to support customization through overrides. (Inherited from DomainClass.) |
|
HasCustomConstructor | Gets or sets the value of HasCustomConstructor domain property. If True, indicates that a custom constructor will be provided in the generated code. (Inherited from DomainClass.) |
|
HasDefaultConnectionPoints | Gets or sets the value of HasDefaultConnectionPoints domain property. If True, the shape will use top, bottom, left and right connection points in the generated designer. |
|
HelpKeyword | Gets or sets the value of HelpKeyword domain property. Optional keyword used to index F1 help for this element. (Inherited from NamedDomainElement.) |
|
Id | Gets the ID of the element. (Inherited from ModelElement.) |
|
InheritanceModifier | Gets or sets the value of InheritanceModifier domain property. Determines if the inheritance modifier of the .NET class generated from the domain class is none, abstract or sealed. (Inherited from DomainClass.) |
|
InitialHeight | Gets or sets the value of InitialHeight domain property. Initial height of this shape, in inches. |
|
InitialWidth | Gets or sets the value of InitialWidth domain property. Initial width of this shape, in inches. |
|
IsActive | Gets the IsActive flag and verifies to see whether the element is active. (Inherited from ModelElement.) |
|
IsDeleted | Gets the IsDeleted flag and checks to see whether the element has been deleted from the model. (Inherited from ModelElement.) |
|
IsDeleting | Gets the IsDeleting flag and verifies whether the element is currently being deleted from the model. (Inherited from ModelElement.) |
|
IsDescriptionTracking | Gets or sets the value of IsDescriptionTracking domain property. If True, the Description property tracks other data in the DSL definition. (Inherited from AttributedDomainElement.) |
|
IsDisplayNameTracking | Gets or sets the value of IsDisplayNameTracking domain property. If True, the DisplayName property tracks other data in the DSL definition. (Inherited from NamedDomainElement.) |
|
IsFixedTooltipTextTracking | Gets or sets the value of IsFixedTooltipTextTracking domain property. If True, the FixedTooltipText property tracks other data in the DSL definition. (Inherited from DiagramElement.) |
|
IsNamespaceTracking | Gets or sets the value of IsNamespaceTracking domain property. If True, the Namespace property tracks other data in the DSL definition. (Inherited from DomainClass.) |
|
Name | Gets or sets the value of Name domain property. Name of this element. (Inherited from NamedDomainElement.) |
|
Namespace | Gets or sets the value of Namespace domain property. Namespace affiliated with this domain class. (Inherited from DomainClass.) |
|
Notes | Gets or sets the value of Notes domain property. Informal notes associated with this element. (Inherited from DomainElement.) |
|
OutlineColor | Gets or sets the value of OutlineColor domain property. Outline color of this shape. |
|
OutlineDashStyle | Gets or sets the value of OutlineDashStyle domain property. Outline dash style of this shape. |
|
OutlineThickness | Gets or sets the value of OutlineThickness domain property. Outline thickness of this shape. |
|
Partition | Gets or sets the Partition that contains the element. (Inherited from ModelElement.) |
|
Properties | Gets a list of Properties. (Inherited from DomainClass.) |
.gif "Protected property") |
ProxyIsNameTracking | (Inherited from NamedDomainElement.) |
|
RolesPlayed | Gets a list of RolesPlayed. Roles played by the class. (Inherited from DomainClass.) |
|
Store | Gets the Store that contains the element. (Inherited from ModelElement.) |
|
SubClasses | Gets a list of SubClasses. Description for Microsoft.VisualStudio.Modeling.DslDefinition.ClassHasBaseClass.BaseClass (Inherited from DomainClass.) |
|
TextColor | Gets or sets the value of TextColor domain property. Color used for text decorators associated with this diagram element. (Inherited from DiagramElement.) |
|
TooltipType | Gets or sets the value of TooltipType domain property. If Fixed, the fixed tooltip text is used as the tooltip, if variable the tooltip is defined in custom code. (Inherited from DiagramElement.) |
Top
Methods
| Name | Description | |
|---|---|---|
|
CalculateDescription | Calculate the value of Description (Inherited from DomainClass.) |
|
CalculateName | Calculates the value of Name (Inherited from NamedDomainElement.) |
|
CanMerge | Returns a value indicating whether the source element represented by the specified root ProtoElement can be added to this element. (Overrides DomainClass.CanMerge(ProtoElementBase, ElementGroupPrototype).) |
|
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.) |
|
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.) |
.gif "Public method") |
Copy() | Creates a copy of the element in the model. (Inherited from ModelElement.) |
|
Copy(IEnumerable<Guid>) | Creates a copy of the element and its child links and elements. (Inherited from ModelElement.) |
|
Delete() | Deletes an element from the model. (Inherited from ModelElement.) |
|
Delete(array<Guid[]) | Deletes an element from the model. (Inherited from ModelElement.) |
|
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
GetDomainClass | Gets the most-derived domain class for this element. (Inherited from ModelElement.) |
|
GetFullName | Gets the fully qualified name for this class (Inherited from DomainClass.) |
|
GetHashCode | Serves as the default hash function. (Inherited from Object.) |
|
GetRelativeName | Gets the name of the domain class relative to the current namespace. If the current namespace is the same as this.Namespace, then we return this.Name. If not, we return this.GetFullName() (Inherited from DomainClass.) |
|
GetRoleCollection<TCollection, TElement>(Guid) | Gets or creates the linked element collection (Inherited from ModelElement.) |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
IsDerivedFrom | Test if this class is derived from the given class. (Inherited from DomainClass.) |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
MergeConfigure | Configure a newly merged DomainClass (Inherited from DomainClass.) |
|
MergeDisconnect | Performs operation opposite to MergeRelate - i.e. disconnects a given element from the current one (removes links created by MergeRelate). (Overrides DomainClass.MergeDisconnect(ModelElement).) |
|
MergeRelate | Called by the Merge process to create a relationship between this target element and the specified source element. Typically, a parent-child relationship is established between the target element (the parent) and the source element (the child), but any relationship can be established. (Overrides DomainClass.MergeRelate(ModelElement, ElementGroup).) |
|
OnCopy | Called when this element has been created as a copy of another element. (Inherited from ModelElement.) |
|
OnDeleted | Called when this element has been deleted from the model. (Inherited from ModelElement.) |
|
OnDeleting | Called when this element is about to be deleted. (Inherited from ModelElement.) |
|
OnInheritanceModifierChanged | Called when InheritanceModifier on a DomainClass changes (Inherited from DomainClass.) |
|
OnNameChanged | Name of DiagramElement changed (Inherited from DiagramElement.) |
|
OnNamespaceChanged | Called when the Namespace of a DomainClass changes (Inherited from DomainClass.) |
|
OnResurrected | Called when this element has been added back to a model. (Inherited from ModelElement.) |
|
OnRolePlayerPositionChanged | Called when the position of a role has changed. (Inherited from ModelElement.) |
|
OnRolePlayerPositionChanging | Called when a role player position is about to change. (Inherited from ModelElement.) |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Top
Extension Methods
| Name | Description | |
|---|---|---|
.gif "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.) |
|
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.) |
|
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.) |
|
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.) |
|
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.) |
|
CanDelete | Deletes the element from the model. (Defined by ImmutabilityExtensionMethods.) |
|
GetAllExtensions | Return an enumerable that performs a breadth first traversal across the tree of extension elements embedded in this ModelElement. (Defined by ModelElementExtensionMethods.) |
|
GetBaseElement | Returns the root of the virtual MEL in which the specified ModelElement is participating. (Defined by ModelElementExtensionMethods.) |
|
GetExtension(Guid) | Overloaded. (Defined by ModelElementExtensionMethods.) |
|
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.) |
|
GetExtension(DomainClassInfo) | Overloaded. (Defined by ModelElementExtensionMethods.) |
|
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.) |
|
GetLocks | Get the lock flags for this element. This will include any locks enabled on the Partition containing the element. (Defined by ImmutabilityExtensionMethods.) |
|
IsExtendedBy(Guid) | Overloaded. Query whether this ModelElement is currently extended by an ExtensionElement of a particular type. (Defined by ModelElementExtensionMethods.) |
|
IsExtendedBy(Type) | Overloaded. Query whether this ModelElement is currently extended by an ExtensionElement of a particular type. (Defined by ModelElementExtensionMethods.) |
|
IsExtendedBy(DomainClassInfo) | Overloaded. Query whether this ModelElement is currently extended by an ExtensionElement of a particular type. (Defined by ModelElementExtensionMethods.) |
|
IsLocked | Test whether this element has any of a specified set of locks (Defined by ImmutabilityExtensionMethods.) |
|
RemoveExtension(Type) | Overloaded. Remove any extension of this ModelElement that is of a particular type. (Defined by ModelElementExtensionMethods.) |
|
RemoveExtension(Guid) | Overloaded. Remove any extension of the specified ModelElement that is of a particular type. (Defined by ModelElementExtensionMethods.) |
|
RemoveExtension(DomainClassInfo) | Overloaded. Remove any extension of the specified ModelElement that is of a particular type. (Defined by ModelElementExtensionMethods.) |
|
RemoveExtension(ExtensionElement) | Overloaded. Remove a specified ExtensionElement from the extensions of this ModelElement. (Defined by ModelElementExtensionMethods.) |
|
SetLocks | Set the lock flags of this element (Defined by ImmutabilityExtensionMethods.) |
|
TryGetExtension(Guid) | Overloaded. (Defined by ModelElementExtensionMethods.) |
|
TryGetExtension(Type) | Overloaded. (Defined by ModelElementExtensionMethods.) |
|
TryGetExtension(DomainClassInfo) | Overloaded. (Defined by ModelElementExtensionMethods.) |
|
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 | |
|---|---|---|
.gif "Public field") .gif "Static member") |
DomainClassId | Shape domain class Id. |
|
ExposesFillColorAsPropertyDomainPropertyId | ExposesFillColorAsProperty domain property Id. |
|
ExposesFillGradientModeDomainPropertyId | ExposesFillGradientMode domain property Id. |
|
ExposesOutlineColorAsPropertyDomainPropertyId | ExposesOutlineColorAsProperty domain property Id. |
|
ExposesOutlineDashStyleAsPropertyDomainPropertyId | ExposesOutlineDashStyleAsProperty domain property Id. |
|
ExposesOutlineThicknessAsPropertyDomainPropertyId | ExposesOutlineThicknessAsProperty domain property Id. |
|
FillColorDomainPropertyId | FillColor domain property Id. |
|
FillGradientModeDomainPropertyId | FillGradientMode domain property Id. |
|
HasDefaultConnectionPointsDomainPropertyId | HasDefaultConnectionPoints domain property Id. |
|
InitialHeightDomainPropertyId | InitialHeight domain property Id. |
|
InitialWidthDomainPropertyId | InitialWidth domain property Id. |
|
OutlineColorDomainPropertyId | OutlineColor domain property Id. |
|
OutlineDashStyleDomainPropertyId | OutlineDashStyle domain property Id. |
|
OutlineThicknessDomainPropertyId | OutlineThickness domain property Id. |
Top
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
.gif "Explicit interface implemetation") .gif "Private method") |
IMergeElements.CanMerge | Returns true if this element can merge with the content of the prototype. (Inherited from ModelElement.) |
|
IMergeElements.ChooseMergeTarget(ElementGroup) | (Inherited from ModelElement.) |
|
IMergeElements.ChooseMergeTarget(ElementGroupPrototype) | (Inherited from ModelElement.) |
|
IMergeElements.MergeConfigure | (Inherited from ModelElement.) |
|
IMergeElements.MergeDisconnect | (Inherited from ModelElement.) |
|
IMergeElements.MergeRelate | (Inherited from ModelElement.) |
Top
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.DslDefinition Namespace
Inheritance Hierarchy
System.Object
Microsoft.VisualStudio.Modeling.ModelElement
Microsoft.VisualStudio.Modeling.DslDefinition.DomainElement
Microsoft.VisualStudio.Modeling.DslDefinition.AttributedDomainElement
Microsoft.VisualStudio.Modeling.DslDefinition.NamedDomainElement
Microsoft.VisualStudio.Modeling.DslDefinition.DomainClass
Microsoft.VisualStudio.Modeling.DslDefinition.DiagramElement
Microsoft.VisualStudio.Modeling.DslDefinition.BaseShape
Microsoft.VisualStudio.Modeling.DslDefinition.Shape
Microsoft.VisualStudio.Modeling.DslDefinition.CompartmentShape
Microsoft.VisualStudio.Modeling.DslDefinition.GeometryShape
Microsoft.VisualStudio.Modeling.DslDefinition.ImageShape