ModelingPackage Class

When overridden in a derived class, represents the VSPackage for the Domain-Specific Language Designer.

This API is not CLS-compliant. 

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Shell.Package
    Microsoft.VisualStudio.Modeling.Shell.ModelingPackage

Namespace:  Microsoft.VisualStudio.Modeling.Shell
Assembly:  Microsoft.VisualStudio.Modeling.Sdk.Shell.12.0 (in Microsoft.VisualStudio.Modeling.Sdk.Shell.12.0.dll)

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
<ComVisibleAttribute(True)> _
Public MustInherit Class ModelingPackage _
    Inherits Package _
    Implements IVsToolWindowFactory

[CLSCompliantAttribute(false)]
[ComVisibleAttribute(true)]
public abstract class ModelingPackage : Package, 
    IVsToolWindowFactory

[CLSCompliantAttribute(false)]
[ComVisibleAttribute(true)]
public ref class ModelingPackage abstract : public Package, 
    IVsToolWindowFactory

[<AbstractClass>]
[<CLSCompliantAttribute(false)>]
[<ComVisibleAttribute(true)>]
type ModelingPackage =  
    class 
        inherit Package 
        interface IVsToolWindowFactory 
    end

public abstract class ModelingPackage extends Package implements IVsToolWindowFactory

The ModelingPackage type exposes the following members.

Constructors

	Name	Description
	ModelingPackage	Initializes a new instance of the ModelingPackage class.

Top

Properties

	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.)

Top

Methods

	Name	Description
	AddOptionKey	(Inherited from Package.)
	AddOrReplaceToolboxItem	Obsolete. Add a toolbox item if it is not present. Will replace an existing toolbox item if the item is already present
	AddToolboxItems	Add the passed collection of ModelingToolboxItemBase items into the Visual Studio toolbox.
	AddToolWindow	Adds a tool window to the generated designer for a domain-specific language.
	CreateInstance	(Inherited from Package.)
	CreateLocator	Creates a model element locator for the package.
	CreateTool	(Inherited from Package.)
	CreateToolboxItems	Creates the items in the Toolbox.
	CreateToolWindow(Type, Int32)	(Inherited from Package.)
	CreateToolWindow(Guid%, UInt32)	Creates a tool window.
	Dispose	(Inherited from Package.)
	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.)
	FindToolWindow	(Inherited from Package.)
	FindWindowPane	(Inherited from Package.)
	GetAutomationObject	(Inherited from Package.)
	GetDialogPage	(Inherited from Package.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetOutputPane	(Inherited from Package.)
	GetProviderLocale	(Inherited from Package.)
	GetService	(Inherited from Package.)
	GetToolboxItemData	(Inherited from Package.)
	GetToolWindow(Type)	Gets a tool window.
	GetToolWindow(Type, Boolean)	Gets a tool window.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Initialize	Initializes the ModelingPackage class. (Overrides Package.Initialize().)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnLoadOptions	(Inherited from Package.)
	OnSaveOptions	(Inherited from Package.)
	OnToolboxInitialized	Event handler for ToolboxInitialized event The dynamic/custom toolbox items will be re-registered.
	OnToolboxUpgraded	Event handler for ToolboxUpgraded event The dynamic/custom toolbox items will be re-registered.
	ParseToolboxResource(TextReader, ResourceManager)	(Inherited from Package.)
	ParseToolboxResource(TextReader, Guid)	(Inherited from Package.)
	QueryClose	(Inherited from Package.)
	RegisterEditorFactory	(Inherited from Package.)
	RegisterProjectFactory	(Inherited from Package.)
	SetupDynamicToolbox	Refreshes the items in the Toolbox.
	ShowOptionPage	(Inherited from Package.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Events

	Name	Description
	ToolboxInitialized	(Inherited from Package.)
	ToolboxUpgraded	(Inherited from Package.)

Top

Explicit Interface Implementations

	Name	Description
	IServiceContainer.AddService(Type, Object)	(Inherited from Package.)
	IServiceContainer.AddService(Type, ServiceCreatorCallback)	(Inherited from Package.)
	IServiceContainer.AddService(Type, Object, Boolean)	(Inherited from Package.)
	IServiceContainer.AddService(Type, ServiceCreatorCallback, Boolean)	(Inherited from Package.)
	IVsPackage.Close	(Inherited from Package.)
	IVsToolWindowFactory.CreateToolWindow	(Inherited from Package.)
	IOleCommandTarget.Exec	(Inherited from Package.)
	IVsUserSettings.ExportSettings	(Inherited from Package.)
	IVsPackage.GetAutomationObject	(Inherited from Package.)
	IVsToolboxItemProvider.GetItemContent	(Inherited from Package.)
	IVsPackage.GetPropertyPage	(Inherited from Package.)
	IServiceProvider.GetService	(Inherited from Package.)
	IVsUserSettings.ImportSettings	(Inherited from Package.)
	IVsPersistSolutionOpts.LoadUserOptions	(Inherited from Package.)
	IVsUserSettingsMigration.MigrateSettings	(Inherited from Package.)
	IVsUserSettingsQuery.NeedExport	(Inherited from Package.)
	IVsPackage.QueryClose	(Inherited from Package.)
	IServiceProvider.QueryService	(Inherited from Package.)
	IOleCommandTarget.QueryStatus	(Inherited from Package.)
	IVsPersistSolutionOpts.ReadUserOptions	(Inherited from Package.)
	IServiceContainer.RemoveService(Type)	(Inherited from Package.)
	IServiceContainer.RemoveService(Type, Boolean)	(Inherited from Package.)
	IVsPackage.ResetDefaults	(Inherited from Package.)
	IVsPersistSolutionOpts.SaveUserOptions	(Inherited from Package.)
	IVsPackage.SetSite	(Inherited from Package.)
	IVsPersistSolutionOpts.WriteUserOptions	(Inherited from Package.)

Top

Remarks

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.

Examples

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; }
  }
    }
}

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.Shell Namespace

IVsToolWindowFactory

IVsPackage