DslLibrary Class

DomainClass DslLibrary Defines a library of components of a DSL definition.

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
<CLSCompliantAttribute(True)> _
<ValidationStateAttribute(ValidationState.Enabled)> _
Public Class DslLibrary _
    Inherits DslLibraryBase

[CLSCompliantAttribute(true)]
[ValidationStateAttribute(ValidationState.Enabled)]
public class DslLibrary : DslLibraryBase

[CLSCompliantAttribute(true)]
[ValidationStateAttribute(ValidationState::Enabled)]
public ref class DslLibrary : public DslLibraryBase

[<CLSCompliantAttribute(true)>]
[<ValidationStateAttribute(ValidationState.Enabled)>]
type DslLibrary =  
    class 
        inherit DslLibraryBase 
    end

public class DslLibrary extends DslLibraryBase

The DslLibrary type exposes the following members.

Constructors

	Name	Description
	DslLibrary(Partition, array<PropertyAssignment[])	Constructor
	DslLibrary(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 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.
	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.)
	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.)
	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.)
	ExplorerBehavior	Gets or sets ExplorerBehavior. Explorer behavior defined by the DSL library. (Inherited from DslLibraryBase.)
	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.)
	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.)
	Partition	Gets or sets the Partition that contains the element. (Inherited from ModelElement.)
	ProxyIsNameTracking	(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	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
	CalculateDescription	Calculate the value of Description (Overrides AttributedDomainElement.CalculateDescription().)
	CalculateName	Calculates the value of Name (Inherited from NamedDomainElement.)
	CanMerge	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)	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 full name of this 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()
	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	Performs operation opposite to MergeRelate - i.e. disconnects a given element from the current one (removes links created by MergeRelate). (Inherited from DslLibraryBase.)
	MergeRelate	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	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 a DslLibrary's Name changes (Overrides NamedDomainElement.OnNameChanged(String, String).)
	OnNamespaceChanged	Called when the Namespace of a DslLibrary changes (Overrides DslLibraryBase.OnNamespaceChanged(String, String).)
	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.)
	ValidateMonikerAmbiguity	Clears the moniker's lookup table and starts the validation (Overrides DslLibraryBase.ValidateMonikerAmbiguity(ValidationContext).)

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

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