ModelingPackage, classe

Une fois substitué dans une classe dérivée, représente le VSPackage pour le concepteur de langage spécifique à un domaine.

Cette API n'est pas conforme CLS. 

Hiérarchie d'héritage

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

Espace de noms :  Microsoft.VisualStudio.Modeling.Shell
Assembly :  Microsoft.VisualStudio.Modeling.Sdk.Shell.11.0 (dans Microsoft.VisualStudio.Modeling.Sdk.Shell.11.0.dll)

Syntaxe

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

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

Le type ModelingPackage expose les membres suivants.

Constructeurs

	Nom	Description
	ModelingPackage	Initialise une nouvelle instance de la classe ModelingPackage.

Début

Propriétés

	Nom	Description
	ApplicationRegistryRoot	(Hérité de Package.)
	Locator	Obtient le localisateur d'élément de modèle, qui place des éléments de modélisation dans le package.
	SetupMode	Obtient le package de modélisation et le vérifie si le concepteur de langage spécifique à un domaine est installation.
	UserDataPath	(Hérité de Package.)
	UserLocalDataPath	(Hérité de Package.)
	UserRegistryRoot	(Hérité de Package.)
	Zombied	(Hérité de Package.)

Début

Méthodes

	Nom	Description
	AddOptionKey	(Hérité de Package.)
	AddOrReplaceToolboxItem	Obsolète. Ajoutez un élément de boîte à outils s'il n'est pas présent.Remplacera un élément existant de boîte à outils si l'élément est déjà installé
	AddToolboxItems	Ajoutez la collection passée d'éléments de ModelingToolboxItemBase dans la Boîte à outils Visual Studio.
	AddToolWindow	Ajoute une fenêtre Outil au générateur généré pour un langage spécifique au domaine.
	CreateInstance	(Hérité de Package.)
	CreateLocator	Crée un localisateur d'élément de modèle pour le package.
	CreateTool	(Hérité de Package.)
	CreateToolboxItems	Crée les éléments dans la boîte à outils.
	CreateToolWindow(Type, Int32)	(Hérité de Package.)
	CreateToolWindow(Guid%, UInt32)	Crée une fenêtre Outil.
	Dispose	(Hérité de Package.)
	Equals	Détermine si l'objet spécifié est identique à l'objet actuel. (Hérité de Object.)
	Finalize	Autorise un objet à tenter de libérer des ressources et d'exécuter d'autres opérations de nettoyage avant qu'il ne soit récupéré par l'opération garbage collection. (Hérité de Object.)
	FindToolWindow	(Hérité de Package.)
	FindWindowPane	(Hérité de Package.)
	GetAutomationObject	(Hérité de Package.)
	GetDialogPage	(Hérité de Package.)
	GetHashCode	Sert de fonction de hachage pour un type particulier. (Hérité de Object.)
	GetOutputPane	(Hérité de Package.)
	GetProviderLocale	(Hérité de Package.)
	GetService	(Hérité de Package.)
	GetToolboxItemData	(Hérité de Package.)
	GetToolWindow(Type)	Obtient une fenêtre Outil.
	GetToolWindow(Type, Boolean)	Obtient une fenêtre Outil.
	GetType	Obtient le Type de l'instance actuelle. (Hérité de Object.)
	Initialize	Initialise la classe ModelingPackage. (Substitue Package.Initialize().)
	MemberwiseClone	Crée une copie superficielle de l'objet Object actuel. (Hérité de Object.)
	OnLoadOptions	(Hérité de Package.)
	OnSaveOptions	(Hérité de Package.)
	OnToolboxInitialized	Le gestionnaire d'événements pour l'événement de ToolboxInitialized éléments dynamiques/personnalisés de boîte à outils re- sera enregistré.
	OnToolboxUpgraded	Le gestionnaire d'événements pour l'événement de ToolboxUpgraded éléments dynamiques/personnalisés de boîte à outils re- sera enregistré.
	ParseToolboxResource(TextReader, ResourceManager)	(Hérité de Package.)
	ParseToolboxResource(TextReader, Guid)	(Hérité de Package.)
	QueryClose	(Hérité de Package.)
	RegisterEditorFactory	(Hérité de Package.)
	RegisterProjectFactory	(Hérité de Package.)
	SetupDynamicToolbox	Actualise les éléments dans la boîte à outils.
	ShowOptionPage	(Hérité de Package.)
	ToString	Retourne une chaîne qui représente l'objet actif. (Hérité de Object.)

Début

Événements

	Nom	Description
	ToolboxInitialized	(Hérité de Package.)
	ToolboxUpgraded	(Hérité de Package.)

Début

Implémentations d'interface explicite

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

Début

Notes

Vous utilisez cette classe pour charger un package de langage spécifique au domaine, qui enregistre une fabrique d'éditeur avec Visual Studio.Visual Studio appelle la fabrique d'éditeur, qui crée le générateur généré pour le langage spécifique au domaine.En plus d'enregistrer des fabriques d'éditeur, vous pouvez également utiliser cette classe pour enregistrer des fenêtres Outil.

Cette classe comprend la prise en charge de menu au niveau de package.Packages que des fenêtres d'outil de support sont requises pour implémenter IVsToolWindowFactory.

Exemples

L'exemple suivant ajoute une fenêtre Outil qui est appelée Fenêtre Outil personnalisée au générateur généré.Lorsque vous ouvrez votre projet dans le générateur généré, l'onglet pour cette fenêtre apparaît à côté de Explorateur de solutions.Lorsque vous cliquez sur l'onglet pour votre fenêtre, un nom qui lit Ceci est la fenêtre d'outils personnalisée apparaît au milieu de la fenêtre Outil

Ce code enregistre la fenêtre Outil :

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

Ce code définit la fenêtre Outil :

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

Sécurité des threads

Tous les membres static (Shared en Visual Basic) publics de ce type sont thread-safe. Il n'est pas garanti que les membres d'instance soient thread-safe.

Voir aussi

Référence

Microsoft.VisualStudio.Modeling.Shell, espace de noms

IVsToolWindowFactory

IVsPackage