Dsl Class
DomainClass Dsl Definition of a Domain Specific Language, which is also a DslLibrary.
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.DslLibraryBase
Microsoft.VisualStudio.Modeling.DslDefinition.DslLibrary
Microsoft.VisualStudio.Modeling.DslDefinition.Dsl
Namespace: Microsoft.VisualStudio.Modeling.DslDefinition
Assembly: Microsoft.VisualStudio.Modeling.Sdk.DslDefinition.12.0 (in Microsoft.VisualStudio.Modeling.Sdk.DslDefinition.12.0.dll)
Syntax
'Declaration
<ValidationStateAttribute(ValidationState.Enabled)> _
<DisplayNameResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.Dsl.DisplayName", _
GetType(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")> _
<DescriptionResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.Dsl.Description", _
GetType(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")> _
<DomainModelOwnerAttribute(GetType(DslDefinitionModelDomainModel))> _
<CLSCompliantAttribute(True)> _
<DomainObjectIdAttribute("1a8ff2a4-90d2-4c48-a80b-920f15abd7cb")> _
<ValidationStateAttribute(ValidationState.Enabled)> _
Public NotInheritable Class Dsl _
Inherits DslLibrary
[ValidationStateAttribute(ValidationState.Enabled)]
[DisplayNameResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.Dsl.DisplayName",
typeof(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[DescriptionResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.Dsl.Description",
typeof(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[DomainModelOwnerAttribute(typeof(DslDefinitionModelDomainModel))]
[CLSCompliantAttribute(true)]
[DomainObjectIdAttribute("1a8ff2a4-90d2-4c48-a80b-920f15abd7cb")]
[ValidationStateAttribute(ValidationState.Enabled)]
public sealed class Dsl : DslLibrary
[ValidationStateAttribute(ValidationState::Enabled)]
[DisplayNameResourceAttribute(L"Microsoft.VisualStudio.Modeling.DslDefinition.Dsl.DisplayName",
typeof(DslDefinitionModelDomainModel), L"Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[DescriptionResourceAttribute(L"Microsoft.VisualStudio.Modeling.DslDefinition.Dsl.Description",
typeof(DslDefinitionModelDomainModel), L"Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[DomainModelOwnerAttribute(typeof(DslDefinitionModelDomainModel))]
[CLSCompliantAttribute(true)]
[DomainObjectIdAttribute(L"1a8ff2a4-90d2-4c48-a80b-920f15abd7cb")]
[ValidationStateAttribute(ValidationState::Enabled)]
public ref class Dsl sealed : public DslLibrary
[<Sealed>]
[<ValidationStateAttribute(ValidationState.Enabled)>]
[<DisplayNameResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.Dsl.DisplayName",
typeof(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")>]
[<DescriptionResourceAttribute("Microsoft.VisualStudio.Modeling.DslDefinition.Dsl.Description",
typeof(DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")>]
[<DomainModelOwnerAttribute(typeof(DslDefinitionModelDomainModel))>]
[<CLSCompliantAttribute(true)>]
[<DomainObjectIdAttribute("1a8ff2a4-90d2-4c48-a80b-920f15abd7cb")>]
[<ValidationStateAttribute(ValidationState.Enabled)>]
type Dsl =
class
inherit DslLibrary
end
public final class Dsl extends DslLibrary
The Dsl type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
Dsl(Partition, array<PropertyAssignment[]) | Constructor |
|
Dsl(Store, array<PropertyAssignment[]) | 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 class generated from the DSL library is public or internal. (Inherited from DslLibraryBase.) |
|
AllLibraries | Returns a list of directly and indirectly imported libraries including this object. (Inherited from DslLibrary.) |
|
Attributes | Gets a list of Attributes. (Inherited from AttributedDomainElement.) |
|
Build | Gets or sets the value of Build domain property. Last part of the four part version number. (Inherited from DslLibraryBase.) |
|
Classes | Gets a list of Classes. Domain classes defined by the DSL library. (Inherited from DslLibraryBase.) |
|
CompanyName | Gets or sets the value of CompanyName domain property. Name of the company for which the designer generated will be registered in Visual Studio. |
|
ConnectionBuilders | Gets a list of ConnectionBuilders. Connection builders defining the DSL library. (Inherited from DslLibraryBase.) |
|
Connectors | Gets a list of Connectors. Connectors defined by DSL library. (Inherited from DslLibraryBase.) |
|
CustomAttributes | Gets or sets the value of CustomAttributes domain property. Used to attribute the code generated from this element. (Inherited from AttributedDomainElement.) |
|
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.) |
|
Diagram | Gets or sets Diagram. Diagram defined by the DSL. |
|
DiagramElements | Gets a list of DiagramElements. Diagram elements defined by the DSL library. (Inherited from DslLibraryBase.) |
|
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.) |
|
DslLibraryImports | Gets a list of DslLibraryImports. Description for Microsoft.VisualStudio.Modeling.DslDefinition.DslLibraryHasDslLibraryImports.DslLibrary (Inherited from DslLibraryBase.) |
|
Editor | Gets or sets Editor. Editor defined by the DSL. |
|
Explorer | Gets or sets Explorer. Explorer defined by the DSL. |
|
ExplorerBehavior | Gets or sets ExplorerBehavior. Explorer behavior defined by the DSL library. (Inherited from DslLibraryBase.) |
|
ExplorerTitleMenuName | Returns the text used in both the Model Explorer and menu (ie Menu View->"Other Windows"->ExplorerTitleMenuName) It constructs the title based on the Explorer.Title + "Explorer" |
|
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.) |
|
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.) |
|
IsPackageNamespaceTracking | Gets or sets the value of IsPackageNamespaceTracking domain property. If True, the PackageNamespace property tracks other data in the DSL definition. |
|
MajorVersion | Gets or sets the value of MajorVersion domain property. First part of the four part version number. (Inherited from DslLibraryBase.) |
|
MinorVersion | Gets or sets the value of MinorVersion domain property. Second part of the four part version number. (Inherited from DslLibraryBase.) |
|
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 of a DSL library. (Inherited from DslLibraryBase.) |
|
NormalizedFilePath | Gets or sets the value of NormalizedFilePath domain property. Description for Microsoft.VisualStudio.Modeling.DslDefinition.DslLibrary.Normalized File Path (Inherited from DslLibraryBase.) |
|
Notes | Gets or sets the value of Notes domain property. Informal notes associated with this element. (Inherited from DomainElement.) |
|
PackageGuid | Gets or sets the value of PackageGuid domain property. The guid for the Visual Studio package generated for this DSL. |
|
PackageNamespace | Gets or sets the value of PackageNamespace domain property. The namespace for the Visual Studio package generated for this DSL. |
|
Partition | Gets or sets the Partition that contains the element. (Inherited from ModelElement.) |
|
ProductName | Gets or sets the value of ProductName domain property. The name of the product that will be registered for the Visual Studio package generated for this DSL. |
|
ReferenceTypes | Gets a list of ReferenceTypes. Reference types defined by the DSL library. (Inherited from DslLibraryBase.) |
|
Relationships | Gets a list of Relationships. Domain relationships defined by the DSL library. (Inherited from DslLibraryBase.) |
|
Revision | Gets or sets the value of Revision domain property. Third part of the four part version number. (Inherited from DslLibraryBase.) |
|
Shapes | Gets a list of Shapes. Shapes defined by the DSL library. (Inherited from DslLibraryBase.) |
|
Store | Gets the Store that contains the element. (Inherited from ModelElement.) |
|
Types | Gets a list of Types. Domain types defined by the DSL library. (Inherited from DslLibraryBase.) |
|
XmlSerializationBehavior | Gets or sets XmlSerializationBehavior. Xml serialization behavior defined by the DSL library. (Inherited from DslLibraryBase.) |
Top
Methods
| Name | Description | |
|---|---|---|
|
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.) |
|
GetDomainClass | Gets the most-derived domain class for this element. (Inherited from ModelElement.) |
|
GetFullName | Gets the full name of this DslLibrary (Inherited from DslLibrary.) |
|
GetHashCode | Serves as the default hash function. (Inherited from Object.) |
|
GetRelativeName | Gets the name of the DslLibrary 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 DslLibrary.) |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
.gif "Protected method") |
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 | |
|---|---|---|
.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") |
CompanyNameDomainPropertyId | CompanyName domain property Id. |
|
DomainClassId | Dsl domain class Id. |
|
IsPackageNamespaceTrackingDomainPropertyId | IsPackageNamespaceTracking domain property Id. |
|
PackageGuidDomainPropertyId | PackageGuid domain property Id. |
|
PackageNamespaceDomainPropertyId | PackageNamespace domain property Id. |
|
ProductNameDomainPropertyId | ProductName 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.