Share via


DomainElement Class

DomainClass DomainElement Abstract base class of all components of a domain specific language definition.

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Modeling.ModelElement
    Microsoft.VisualStudio.Modeling.DslDefinition.DomainElement
      More...

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

Syntax

'Declaration
<DescriptionResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.DomainElement.Description",  _
    GetType(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")> _
<DomainModelOwnerAttribute(GetType(DslDefinitionModelDomainModel))> _
<DomainObjectIdAttribute("a6d03d16-b388-4763-bd0b-c583085ef6c1")> _
<DisplayNameResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.DomainElement.DisplayName",  _
    GetType(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")> _
<CLSCompliantAttribute(True)> _
Public MustInherit Class DomainElement _
    Inherits ModelElement
[DescriptionResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.DomainElement.Description", 
    typeof(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[DomainModelOwnerAttribute(typeof(DslDefinitionModelDomainModel))]
[DomainObjectIdAttribute("a6d03d16-b388-4763-bd0b-c583085ef6c1")]
[DisplayNameResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.DomainElement.DisplayName", 
    typeof(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[CLSCompliantAttribute(true)]
public abstract class DomainElement : ModelElement
[DescriptionResourceAttribute(L"Microsoft.VisualStudio.Modeling.DslDefinition.DomainElement.Description", 
    typeof(DslDefinitionModelDomainModel), L"Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[DomainModelOwnerAttribute(typeof(DslDefinitionModelDomainModel))]
[DomainObjectIdAttribute(L"a6d03d16-b388-4763-bd0b-c583085ef6c1")]
[DisplayNameResourceAttribute(L"Microsoft.VisualStudio.Modeling.DslDefinition.DomainElement.DisplayName", 
    typeof(DslDefinitionModelDomainModel), L"Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[CLSCompliantAttribute(true)]
public ref class DomainElement abstract : public ModelElement
[<AbstractClass>]
[<DescriptionResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.DomainElement.Description", 
    typeof(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")>]
[<DomainModelOwnerAttribute(typeof(DslDefinitionModelDomainModel))>]
[<DomainObjectIdAttribute("a6d03d16-b388-4763-bd0b-c583085ef6c1")>]
[<DisplayNameResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.DomainElement.DisplayName", 
    typeof(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")>]
[<CLSCompliantAttribute(true)>]
type DomainElement =  
    class
        inherit ModelElement
    end
public abstract class DomainElement extends ModelElement

The DomainElement type exposes the following members.

Constructors

  Name Description
Protected method DomainElement Constructor.

Top

Properties

  Name Description
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 Notes Gets or sets the value of Notes domain property. Informal notes associated with this element.
Public property Partition Gets or sets the Partition that contains the element. (Inherited from ModelElement.)
Public property Store Gets the Store that contains the element. (Inherited from ModelElement.)

Top

Methods

  Name Description
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 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.)
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.)
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 GetDomainClass Gets the most-derived domain class for this element. (Inherited from ModelElement.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Protected method GetRoleCollection<TCollection, TElement>(Guid) Gets or creates the linked element collection (Inherited from ModelElement.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method MergeConfigure Allows the model element to configure itself immediately after the Merge process has related it to the target element. (Inherited from ModelElement.)
Protected method MergeDisconnect Disconnects a source element from a target element. (Inherited from ModelElement.)
Protected method MergeRelate Creates a relationship between this target element and the specified source element. (Inherited from ModelElement.)
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.)
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 ToString Returns a string that represents the current object. (Inherited from Object.)

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 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 DomainClassId DomainElement domain class Id.
Public fieldStatic member NotesDomainPropertyId Notes domain property Id.

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

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.AttributeParameter
      Microsoft.VisualStudio.Modeling.DslDefinition.ClrAttribute
      Microsoft.VisualStudio.Modeling.DslDefinition.Compartment
      Microsoft.VisualStudio.Modeling.DslDefinition.CompartmentMap
      Microsoft.VisualStudio.Modeling.DslDefinition.ConnectionBuilder
      Microsoft.VisualStudio.Modeling.DslDefinition.Decorator
      Microsoft.VisualStudio.Modeling.DslDefinition.DecoratorMap
      Microsoft.VisualStudio.Modeling.DslDefinition.DiagramElementMap
      Microsoft.VisualStudio.Modeling.DslDefinition.DomainPath
      Microsoft.VisualStudio.Modeling.DslDefinition.DomainType
      Microsoft.VisualStudio.Modeling.DslDefinition.DomainTypeDescriptor
      Microsoft.VisualStudio.Modeling.DslDefinition.Editor
      Microsoft.VisualStudio.Modeling.DslDefinition.ElementMergeDirective
      Microsoft.VisualStudio.Modeling.DslDefinition.Explorer
      Microsoft.VisualStudio.Modeling.DslDefinition.ExplorerBehavior
      Microsoft.VisualStudio.Modeling.DslDefinition.ExplorerNodeSettings
      Microsoft.VisualStudio.Modeling.DslDefinition.LinkConnectDirective
      Microsoft.VisualStudio.Modeling.DslDefinition.PathSegment
      Microsoft.VisualStudio.Modeling.DslDefinition.PropertyFilter
      Microsoft.VisualStudio.Modeling.DslDefinition.PropertyPath
      Microsoft.VisualStudio.Modeling.DslDefinition.RolePlayerConnectDirective
      Microsoft.VisualStudio.Modeling.DslDefinition.Tool
      Microsoft.VisualStudio.Modeling.DslDefinition.ToolboxTab
      Microsoft.VisualStudio.Modeling.DslDefinition.Validation
      Microsoft.VisualStudio.Modeling.DslDefinition.XmlClassData
      Microsoft.VisualStudio.Modeling.DslDefinition.XmlElementData
      Microsoft.VisualStudio.Modeling.DslDefinition.XmlSerializationBehavior
      Microsoft.VisualStudio.Modeling.DslDefinition.XmlSerializationDefinition