ModelingPackage Class
When overridden in a derived class, represents the VSPackage for the Domain-Specific Language Designer.
Assembly: Microsoft.VisualStudio.Modeling.Sdk.Shell.12.0 (in Microsoft.VisualStudio.Modeling.Sdk.Shell.12.0.dll)
Microsoft.VisualStudio.Shell::Package
Microsoft.VisualStudio.Modeling.Shell::ModelingPackage
| Name | Description | |
|---|---|---|
![]() | ModelingPackage() | Initializes a new instance of the ModelingPackage class. |
| Name | Description | |
|---|---|---|
![]() | ApplicationRegistryRoot | (Inherited from Package.) |
![]() | Locator | Gets the model element locator, which locates modeling elements in the package. |
![]() | SetupMode | Gets the modeling package and verifies whether the Domain-Specific Language Designer is being set up. |
![]() | UserDataPath | (Inherited from Package.) |
![]() | UserLocalDataPath | (Inherited from Package.) |
![]() | UserRegistryRoot | (Inherited from Package.) |
![]() | Zombied | (Inherited from Package.) |
| Name | Description | |
|---|---|---|
![]() | ToolboxInitialized | (Inherited from Package.) |
![]() | ToolboxUpgraded | (Inherited from Package.) |
You use this class to load a domain-specific language package, which registers an editor factory with Visual Studio. Visual Studio calls the editor factory, which creates the generated designer for the domain-specific language. In addition to registering editor factories, you can also use this class to register tool windows.
This class includes menu support at the package level. Packages that support tool windows are required to implement IVsToolWindowFactory.
The following example adds a tool window that is called Custom Tool Window to the generated designer. When you open your project in the generated designer, the tab for this window appears next to Solution Explorer. When you click the tab for your window, a label that reads This is the custom tool window appears in the middle of the tool window
This code registers the tool window:
using VSShellInterop = Microsoft.VisualStudio.Shell.Interop; using VSShell = Microsoft.VisualStudio.Shell; using DslShell = Microsoft.VisualStudio.Modeling.Shell; using DslDesign = Microsoft.VisualStudio.Modeling.Design; using VSTextTemplatingHost = Microsoft.VisualStudio.TextTemplating.VSHost; namespace MS.RegisterTools { [VSShell::ProvideToolWindowVisibility(typeof(CustomToolWindow), Constants.RegisterToolsEditorFactoryId)] [VSShell::ProvideToolWindow(typeof(CustomToolWindow), MultiInstances = false, Style = VSShell::VsDockStyle.Tabbed, Orientation = VSShell::ToolWindowOrientation.Right, Window = "{3AE79031-E1BC-11D0-8F78-00A0C9110057}")] internal partial class RegisterToolsPackage { //Initializes the base class for the package protected override void Initialize() { base.Initialize(); //Registers the custom tool window this.AddToolWindow(typeof(CustomToolWindow)); } } }
This code defines the tool window:
using System; using System.Windows.Forms; using VSShellInterop = Microsoft.VisualStudio.Shell.Interop; using VSShell = Microsoft.VisualStudio.Shell; using DslShell = Microsoft.VisualStudio.Modeling.Shell; using DslDesign = Microsoft.VisualStudio.Modeling.Design; using VSTextTemplatingHost = Microsoft.VisualStudio.TextTemplating.VSHost; namespace MS.RegisterTools { //Creates a tool window and gives it a title, icon, and label internal class CustomToolWindow : DslShell.ToolWindow { //defines a label private Label myLabel; //creates the tool window public CustomToolWindow(IServiceProvider serviceProvider) : base(serviceProvider) { } //gets the icon for the tool window protected override int BitmapResource { get { return 104; } } //gets the index for the icon protected override int BitmapIndex { get { return 0; } } //gets the name of the tool window public override string WindowTitle { get { return "Custom Window"; } } //sets up a label protected override void OnToolWindowCreate() { this.myLabel = new Label(); this.myLabel.TextAlign = System.Drawing.ContentAlignment.MiddleCenter; this.myLabel.Text = "This is the custom tool window"; } //puts a label on the tool window public override System.Windows.Forms.IWin32Window Window { get { return this.myLabel; } } } }
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.







