DomainEnumeration Class

DomainClass DomainEnumeration Defines an enumeration.

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Modeling.ModelElement
    Microsoft.VisualStudio.Modeling.DslDefinition.DomainElement
      Microsoft.VisualStudio.Modeling.DslDefinition.DomainType
        Microsoft.VisualStudio.Modeling.DslDefinition.DomainEnumeration

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.DomainEnumeration.Description",  _
    GetType(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")> _
<CLSCompliantAttribute(True)> _
<DomainObjectIdAttribute("63e370df-375a-483f-9a5b-3563fbe721da")> _
<ValidationStateAttribute(ValidationState.Enabled)> _
<DomainModelOwnerAttribute(GetType(DslDefinitionModelDomainModel))> _
<DisplayNameResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.DomainEnumeration.DisplayName",  _
    GetType(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")> _
Public NotInheritable Class DomainEnumeration _
    Inherits DomainType

[DescriptionResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.DomainEnumeration.Description", 
    typeof(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[CLSCompliantAttribute(true)]
[DomainObjectIdAttribute("63e370df-375a-483f-9a5b-3563fbe721da")]
[ValidationStateAttribute(ValidationState.Enabled)]
[DomainModelOwnerAttribute(typeof(DslDefinitionModelDomainModel))]
[DisplayNameResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.DomainEnumeration.DisplayName", 
    typeof(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
public sealed class DomainEnumeration : DomainType

[DescriptionResourceAttribute(L"Microsoft.VisualStudio.Modeling.DslDefinition.DomainEnumeration.Description", 
    typeof(DslDefinitionModelDomainModel), L"Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[CLSCompliantAttribute(true)]
[DomainObjectIdAttribute(L"63e370df-375a-483f-9a5b-3563fbe721da")]
[ValidationStateAttribute(ValidationState::Enabled)]
[DomainModelOwnerAttribute(typeof(DslDefinitionModelDomainModel))]
[DisplayNameResourceAttribute(L"Microsoft.VisualStudio.Modeling.DslDefinition.DomainEnumeration.DisplayName", 
    typeof(DslDefinitionModelDomainModel), L"Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
public ref class DomainEnumeration sealed : public DomainType

[<Sealed>]
[<DescriptionResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.DomainEnumeration.Description", 
    typeof(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")>]
[<CLSCompliantAttribute(true)>]
[<DomainObjectIdAttribute("63e370df-375a-483f-9a5b-3563fbe721da")>]
[<ValidationStateAttribute(ValidationState.Enabled)>]
[<DomainModelOwnerAttribute(typeof(DslDefinitionModelDomainModel))>]
[<DisplayNameResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.DomainEnumeration.DisplayName", 
    typeof(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")>]
type DomainEnumeration =  
    class
        inherit DomainType
    end

public final class DomainEnumeration extends DomainType

The DomainEnumeration type exposes the following members.

Constructors

	Name	Description
	DomainEnumeration(Partition, array<PropertyAssignment[])	Constructor
	DomainEnumeration(Store, array<PropertyAssignment[])	Constructor

Top

Properties

	Name	Description
	AccessModifier	Gets or sets the value of AccessModifier domain property. Determines if the access modifier for the domain enumeration is public or internal.
	Attributes	Gets a list of Attributes. Clr attributes defined for the enumeration.
	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.
	DslLibrary	Gets or sets DslLibrary. Dsl library defining the domain type. (Inherited from DomainType.)
	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.
	IsFlags	Gets or sets the value of IsFlags domain property. If True, defines a flags enumeration.
	IsNamespaceTracking	Gets or sets the value of IsNamespaceTracking domain property. If True, the Namespace property tracks other data in the DSL definition.
	Literals	Gets a list of Literals. Literals defined by the enumeration.
	Name	Gets or sets the value of Name domain property. Name of the type. (Inherited from DomainType.)
	Namespace	Gets or sets the value of Namespace domain property. Namespace affiliated with this type. (Inherited from DomainType.)
	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.)
	ProxyIsNamespaceTracking	(Inherited from DomainType.)
	Store	Gets the Store that contains the element. (Inherited from ModelElement.)

Top

Methods

	Name	Description
	CalculateNamespace	Calculates the value of Namespace (Inherited from DomainType.)
	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.)
	GetFullName	Gets the fully qualified name of this domain type (Inherited from DomainType.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetRelativeName	Gets the name of the domain type 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 DomainType.)
	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.)
	OnNameChanged	Called when the Name of a type changes (Inherited from DomainType.)
	OnNamespaceChanged	Called when the Namespace of a type changes (Inherited from DomainType.)
	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
	AccessModifierDomainPropertyId	AccessModifier domain property Id.
	CustomAttributesDomainPropertyId	CustomAttributes domain property Id.
	DescriptionDomainPropertyId	Description domain property Id.
	DomainClassId	DomainEnumeration domain class Id.
	IsDescriptionTrackingDomainPropertyId	IsDescriptionTracking domain property Id.
	IsFlagsDomainPropertyId	IsFlags domain property Id.
	IsNamespaceTrackingDomainPropertyId	IsNamespaceTracking 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.

See Also

Reference

Microsoft.VisualStudio.Modeling.DslDefinition Namespace