AttributedDomainElement Class
DomainClass AttributedDomainElement Domain elements that can have CLR Attributes defined on them.
Inheritance Hierarchy
System.Object
Microsoft.VisualStudio.Modeling.ModelElement
Microsoft.VisualStudio.Modeling.DslDefinition.DomainElement
Microsoft.VisualStudio.Modeling.DslDefinition.AttributedDomainElement
Microsoft.VisualStudio.Modeling.DslDefinition.EnumerationLiteral
Microsoft.VisualStudio.Modeling.DslDefinition.NamedDomainElement
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.AttributedDomainElement.DisplayName", _
GetType(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")> _
<DescriptionResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.AttributedDomainElement.Description", _
GetType(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")> _
<DomainModelOwnerAttribute(GetType(DslDefinitionModelDomainModel))> _
<CLSCompliantAttribute(True)> _
<DomainObjectIdAttribute("44b7c3f8-6100-4acd-8977-735daf883fbf")> _
Public MustInherit Class AttributedDomainElement _
Inherits DomainElement
[DisplayNameResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.AttributedDomainElement.DisplayName",
typeof(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[DescriptionResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.AttributedDomainElement.Description",
typeof(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[DomainModelOwnerAttribute(typeof(DslDefinitionModelDomainModel))]
[CLSCompliantAttribute(true)]
[DomainObjectIdAttribute("44b7c3f8-6100-4acd-8977-735daf883fbf")]
public abstract class AttributedDomainElement : DomainElement
[DisplayNameResourceAttribute(L"Microsoft.VisualStudio.Modeling.DslDefinition.AttributedDomainElement.DisplayName",
typeof(DslDefinitionModelDomainModel), L"Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[DescriptionResourceAttribute(L"Microsoft.VisualStudio.Modeling.DslDefinition.AttributedDomainElement.Description",
typeof(DslDefinitionModelDomainModel), L"Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[DomainModelOwnerAttribute(typeof(DslDefinitionModelDomainModel))]
[CLSCompliantAttribute(true)]
[DomainObjectIdAttribute(L"44b7c3f8-6100-4acd-8977-735daf883fbf")]
public ref class AttributedDomainElement abstract : public DomainElement
[<AbstractClass>]
[<DisplayNameResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.AttributedDomainElement.DisplayName",
typeof(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")>]
[<DescriptionResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.AttributedDomainElement.Description",
typeof(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")>]
[<DomainModelOwnerAttribute(typeof(DslDefinitionModelDomainModel))>]
[<CLSCompliantAttribute(true)>]
[<DomainObjectIdAttribute("44b7c3f8-6100-4acd-8977-735daf883fbf")>]
type AttributedDomainElement =
class
inherit DomainElement
end
public abstract class AttributedDomainElement extends DomainElement
The AttributedDomainElement type exposes the following members.
Constructors
Name | Description | |
---|---|---|
AttributedDomainElement | Constructor. |
Top
Properties
Name | Description | |
---|---|---|
Attributes | Gets a list of Attributes. | |
CustomAttributes | Gets or sets the value of CustomAttributes domain property. Used to attribute the code generated from this element. | |
Description | Gets or sets the value of Description domain property. Used in the UI and in the code documentation of the generated designer. | |
Id | Gets the ID of the element. (Inherited from ModelElement.) | |
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. | |
Notes | Gets or sets the value of Notes domain property. Informal notes associated with this element. (Inherited from DomainElement.) | |
Partition | Gets or sets the Partition that contains the element. (Inherited from ModelElement.) | |
Store | Gets the Store that contains the element. (Inherited from ModelElement.) |
Top
Methods
Name | Description | |
---|---|---|
CalculateDescription | Calculates the value of Description | |
CanMerge | Verifies whether a source element can be added to this element. (Inherited from ModelElement.) | |
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.) | |
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.) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
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.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
MergeConfigure | Allows the model element to configure itself immediately after the Merge process has related it to the target element. (Inherited from ModelElement.) | |
MergeDisconnect | Disconnects a source element from a target element. (Inherited from ModelElement.) | |
MergeRelate | Creates a relationship between this target element and the specified source element. (Inherited from ModelElement.) | |
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.) | |
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 | |
---|---|---|
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 | |
---|---|---|
CustomAttributesDomainPropertyId | CustomAttributes domain property Id. | |
DescriptionDomainPropertyId | Description domain property Id. | |
DomainClassId | AttributedDomainElement domain class Id. | |
IsDescriptionTrackingDomainPropertyId | IsDescriptionTracking domain property Id. |
Top
Explicit Interface Implementations
Name | Description | |
---|---|---|
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.