Dsl Class

Definition

Namespace:

Microsoft.VisualStudio.Modeling.DslDefinition

Assembly:

Microsoft.VisualStudio.Modeling.Sdk.DslDefinition.15.0.dll

DomainClass Dsl Definition of a Domain Specific Language, which is also a DslLibrary.

public ref class Dsl sealed : Microsoft::VisualStudio::Modeling::DslDefinition::DslLibrary

[Microsoft.VisualStudio.Modeling.Design.DescriptionResource("Microsoft.VisualStudio.Modeling.DslDefinition.Dsl.Description", typeof(Microsoft.VisualStudio.Modeling.DslDefinition.DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[Microsoft.VisualStudio.Modeling.Design.DisplayNameResource("Microsoft.VisualStudio.Modeling.DslDefinition.Dsl.DisplayName", typeof(Microsoft.VisualStudio.Modeling.DslDefinition.DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")]
[Microsoft.VisualStudio.Modeling.DomainModelOwner(typeof(Microsoft.VisualStudio.Modeling.DslDefinition.DslDefinitionModelDomainModel))]
[Microsoft.VisualStudio.Modeling.DomainObjectId("1a8ff2a4-90d2-4c48-a80b-920f15abd7cb")]
[Microsoft.VisualStudio.Modeling.Validation.ValidationState(Microsoft.VisualStudio.Modeling.Validation.ValidationState.Enabled)]
[System.CLSCompliant(true)]
public sealed class Dsl : Microsoft.VisualStudio.Modeling.DslDefinition.DslLibrary

[<Microsoft.VisualStudio.Modeling.Design.DescriptionResource("Microsoft.VisualStudio.Modeling.DslDefinition.Dsl.Description", typeof(Microsoft.VisualStudio.Modeling.DslDefinition.DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")>]
[<Microsoft.VisualStudio.Modeling.Design.DisplayNameResource("Microsoft.VisualStudio.Modeling.DslDefinition.Dsl.DisplayName", typeof(Microsoft.VisualStudio.Modeling.DslDefinition.DslDefinitionModelDomainModel), "Microsoft.VisualStudio.Modeling.DslDefinition.GeneratedCode.DomainModelResx")>]
[<Microsoft.VisualStudio.Modeling.DomainModelOwner(typeof(Microsoft.VisualStudio.Modeling.DslDefinition.DslDefinitionModelDomainModel))>]
[<Microsoft.VisualStudio.Modeling.DomainObjectId("1a8ff2a4-90d2-4c48-a80b-920f15abd7cb")>]
[<Microsoft.VisualStudio.Modeling.Validation.ValidationState(Microsoft.VisualStudio.Modeling.Validation.ValidationState.Enabled)>]
[<System.CLSCompliant(true)>]
type Dsl = class
    inherit DslLibrary

Public NotInheritable Class Dsl
Inherits DslLibrary

Inheritance

Object

ModelElement

DomainElement

AttributedDomainElement

NamedDomainElement

DslLibraryBase

DslLibrary

Dsl

Attributes

DescriptionResourceAttribute DisplayNameResourceAttribute DomainModelOwnerAttribute DomainObjectIdAttribute ValidationStateAttribute CLSCompliantAttribute

Constructors

Dsl(Partition, PropertyAssignment[])	Constructor
Dsl(Store, PropertyAssignment[])	Constructor

Fields

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.

Properties

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	Unique identifier of this element. (Inherited from ModelElement)
IsActive	Returns true if the Element is currently active within the model, false if the element has been deleted or is in the process of being deleted. (Inherited from ModelElement)
IsDeleted	Has the element been deleted from the model. (Deleted elements are not immediately destroyed so that the undo command may undo deleting the element.) (Inherited from ModelElement)
IsDeleting	Has the element been deleted from the model. (Deleted elements are not immediately destroyed so that the undo command may undo deleting the element.) (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 instance that contains this 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.
ProxyIsNameTracking	Virtualized version of IsNameTracking to cope with the fact that derived classes own the IsNameTracking flags (Inherited from NamedDomainElement)
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	Get the Store instance that contains this 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)

Methods

CalculateDescription()	Calculate the value of Description (Inherited from DslLibrary)
CalculateName()	Calculates the value of Name (Inherited from NamedDomainElement)
CanMerge(ProtoElementBase, ElementGroupPrototype)	Returns a value indicating whether the source element represented by the specified root ProtoElement can be added to this element. (Inherited from DslLibraryBase)
ChooseMergeTarget(ElementGroup)	Gets the ModelElement to be used as the target for the ElementGroup merge process. This is called by the merge process when this element is the target of the merge. This provides this element with the opportunity to change the target to something other than itself. (Inherited from ModelElement)
ChooseMergeTarget(ElementGroupPrototype)	Gets the ModelElement to be used as the target for the ElementGroupPrototype merge process. This is called by the merge process when this element is the target of the merge. This provides this element with the opportunity to change the target to something other than itself. (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 in the model. (Inherited from ModelElement)
Delete()	Deletes the element from the model. (Inherited from ModelElement)
Delete(Guid[])	Deletes the element from the model. (Inherited from ModelElement)
GetDomainClass()	Gets the most-derived domain class for this element. (Inherited from ModelElement)
GetFullName(Boolean)	Gets the full name of this DslLibrary (Inherited from DslLibrary)
GetRelativeName(String, Boolean)	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)
GetRoleCollection<TCollection,TElement>(Guid)	Gets or creates the linked element collection (Inherited from ModelElement)
MergeConfigure(ElementGroup)	Called by the Merge process to allow this model element to configure itself immediately after the Merge process has related it to the target element. (Inherited from ModelElement)
MergeDisconnect(ModelElement)	Performs operation opposite to MergeRelate - i.e. disconnects a given element from the current one (removes links created by MergeRelate). (Inherited from DslLibraryBase)
MergeRelate(ModelElement, ElementGroup)	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. (Inherited from DslLibraryBase)
OnCopy(ModelElement)	Called when a copy of the element has been created. The method is called on the duplicate element. (Inherited from ModelElement)
OnDeleted()	Called by the model after the element has been deleted. (Inherited from ModelElement)
OnDeleting()	Called by the model before the element is deleted. (Inherited from ModelElement)
OnNameChanged(String, String)	Called when a DslLibrary's Name changes (Inherited from DslLibrary)
OnNamespaceChanged(String, String)	Called when the Namespace of a DslLibrary changes (Inherited from DslLibrary)
OnResurrected()	Called by the model after the element has been resurrected (placed back into the store). (Inherited from ModelElement)
OnRolePlayerPositionChanged(DomainRoleInfo, ElementLink, Int32, Int32)	Virtual method for notifying when role player position has changed. (Inherited from ModelElement)
OnRolePlayerPositionChanging(DomainRoleInfo, ElementLink, Int32, Int32)	Virtual method for notifying when role player position will be changing. (Inherited from ModelElement)
ValidateMonikerAmbiguity(ValidationContext)	Clears the moniker's lookup table and starts the validation (Inherited from DslLibrary)

Explicit Interface Implementations

IMergeElements.CanMerge(ProtoElementBase, ElementGroupPrototype)	(Inherited from ModelElement)
IMergeElements.ChooseMergeTarget(ElementGroup)	(Inherited from ModelElement)
IMergeElements.ChooseMergeTarget(ElementGroupPrototype)	(Inherited from ModelElement)
IMergeElements.MergeConfigure(ElementGroup)	(Inherited from ModelElement)
IMergeElements.MergeDisconnect(ModelElement)	(Inherited from ModelElement)
IMergeElements.MergeRelate(ModelElement, ElementGroup)	(Inherited from ModelElement)

Extension Methods

AddExtension(ModelElement, DomainClassInfo)	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.
AddExtension(ModelElement, ExtensionElement)	Extend this ModelElement with a specific extension. An InvalidOperationException will be thrown if the element already has an extension of the same type.
AddExtension(ModelElement, Guid)	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.
AddExtension(ModelElement, Type)	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.
AddExtension<T>(ModelElement)	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.
GetAllExtensions(ModelElement)	Return an enumerable that performs a breadth first traversal across the tree of extension elements embedded in this ModelElement.
GetBaseElement(ModelElement)	Returns the root of the virtual MEL in which the specified ModelElement is participating.
GetExtension(ModelElement, DomainClassInfo)
GetExtension(ModelElement, Guid)
GetExtension(ModelElement, Type)	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.
GetExtension<T>(ModelElement)	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.
IsExtendedBy(ModelElement, DomainClassInfo)	Query whether this ModelElement is currently extended by an ExtensionElement of a particular type.
IsExtendedBy(ModelElement, Guid)	Query whether this ModelElement is currently extended by an ExtensionElement of a particular type.
IsExtendedBy(ModelElement, Type)	Query whether this ModelElement is currently extended by an ExtensionElement of a particular type.
RemoveExtension(ModelElement, DomainClassInfo)	Remove any extension of the specified ModelElement that is of a particular type.
RemoveExtension(ModelElement, ExtensionElement)	Remove a specified ExtensionElement from the extensions of this ModelElement.
RemoveExtension(ModelElement, Guid)	Remove any extension of the specified ModelElement that is of a particular type.
RemoveExtension(ModelElement, Type)	Remove any extension of this ModelElement that is of a particular type.
TryGetExtension(ModelElement, DomainClassInfo)
TryGetExtension(ModelElement, Guid)
TryGetExtension(ModelElement, Type)
TryGetExtension<T>(ModelElement)	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.
CanDelete(ModelElement, Guid[])	Deletes the element from the model.
GetLocks(ModelElement)	Get the lock flags for this element. This will include any locks enabled on the Partition containing the element.
IsLocked(ModelElement, Locks)	Test whether this element has any of a specified set of locks
SetLocks(ModelElement, Locks)	Set the lock flags of this element