Compartir a través de


Package Class

Provides a managed implementation of the interfaces required to create a fully functional VSPackage.

Inheritance Hierarchy

Object
  Microsoft.VisualStudio.Shell.Package
    Microsoft.VisualStudio.Shell.ExtensionPointPackage

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

Syntax

'Declaration
<PackageRegistrationAttribute> _
<ComVisibleAttribute(True)> _
Public MustInherit Class Package _
    Implements IVsPackage, IServiceProvider, IOleCommandTarget, IVsPersistSolutionOpts,  _
    IServiceContainer, IServiceProvider, IVsUserSettings, IVsUserSettingsMigration, IVsUserSettingsQuery,  _
    IVsToolWindowFactory, IVsToolboxItemProvider
[PackageRegistrationAttribute]
[ComVisibleAttribute(true)]
public abstract class Package : IVsPackage, 
    IServiceProvider, IOleCommandTarget, IVsPersistSolutionOpts, IServiceContainer, IServiceProvider, 
    IVsUserSettings, IVsUserSettingsMigration, IVsUserSettingsQuery, IVsToolWindowFactory, IVsToolboxItemProvider
[PackageRegistrationAttribute]
[ComVisibleAttribute(true)]
public ref class Package abstract : IVsPackage, 
    IServiceProvider, IOleCommandTarget, IVsPersistSolutionOpts, IServiceContainer, IServiceProvider, 
    IVsUserSettings, IVsUserSettingsMigration, IVsUserSettingsQuery, IVsToolWindowFactory, IVsToolboxItemProvider
[<AbstractClass>]
[<PackageRegistrationAttribute>]
[<ComVisibleAttribute(true)>]
type Package =  
    class 
        interface IVsPackage 
        interface IServiceProvider 
        interface IOleCommandTarget 
        interface IVsPersistSolutionOpts 
        interface IServiceContainer 
        interface IServiceProvider 
        interface IVsUserSettings 
        interface IVsUserSettingsMigration 
        interface IVsUserSettingsQuery 
        interface IVsToolWindowFactory 
        interface IVsToolboxItemProvider 
    end
public abstract class Package implements IVsPackage, IServiceProvider, IOleCommandTarget, IVsPersistSolutionOpts, IServiceContainer, IServiceProvider, IVsUserSettings, IVsUserSettingsMigration, IVsUserSettingsQuery, IVsToolWindowFactory, IVsToolboxItemProvider

The Package type exposes the following members.

Constructors

  Name Description
Protected method Package Initializes a new instance of Package.

Top

Properties

  Name Description
Public property ApplicationRegistryRoot Gets the root registry key of the current Visual Studio registry hive.
Public property UserDataPath Gets the path to user data storage for Visual Studio.
Public property UserLocalDataPath Gets the path to local user data storage for Visual Studio.
Public property UserRegistryRoot Gets a registry key that can be used to store user data.
Public property Zombied Gets a value indicating whether the package in the process of shutdown.

Top

Methods

  Name Description
Protected method AddOptionKey Adds a user option key name into the list of option keys.
Public method CreateInstance Creates the specified COM object using the Visual Studio's local registry CLSID object.
Public method CreateTool Enables derived classes to provide an implementation if necessary.
Protected method CreateToolWindow Creates a tool window of the specified type with the specified ID.
Protected method Dispose Releases the resources used by the Package object.
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method FindToolWindow Gets the tool window corresponding to the specified type and ID.
Public method FindWindowPane Gets the window pane corresponding to the specified type and ID, and if no window pane of that type exists creates one if told to do so.
Protected method GetAutomationObject Gets the automation object for the VSPackage.
Protected method GetDialogPage Gets the requested dialog page.
Public methodStatic member GetGlobalService Gets a service proffered globally by Visual Studio or one of its packages. This is the same as calling GetService() on an instance of a package that proffers no services itself.
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetOutputPane Gets the requested output window.
Public method GetProviderLocale Returns the locale associated with this service provider.
Protected method GetService Gets type-based services from the VSPackage service container.
Protected method GetToolboxItemData Gets the content of the data format for the specified toolbox item ID and data format.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method Initialize Called when the VSPackage is loaded by Visual Studio.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnLoadOptions Invoked by the package class when there are options to be read out of the solution file.
Protected method OnSaveOptions Invoked by the Package class when there are options to be saved to the solution file.
Protected method ParseToolboxResource(TextReader, Guid) Parses an embedded text resource of appropriate format for information about which items should be added to the Toolbox.
Protected method ParseToolboxResource(TextReader, ResourceManager) Parses an embedded text resource of appropriate format for information about which items should be added to the Toolbox.
Protected method QueryClose Called to ask the package if the shell can be closed.
Protected method RegisterEditorFactory Registers an editor factory with Visual Studio.
Protected method RegisterProjectFactory Registers a project factory with Visual Studio.
Public method ShowOptionPage Displays a specified tools options page.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Events

  Name Description
Protected event ToolboxInitialized Event generated whenever Visual Studio initializes its Toolbox.
Protected event ToolboxUpgraded Event generated whenever Visual Studio upgrades its Toolbox.

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IServiceContainer.AddService(Type, ServiceCreatorCallback) Infrastructure. Adds the given service to the VSPackage's service container.
Explicit interface implemetationPrivate method IServiceContainer.AddService(Type, Object) Infrastructure. Adds the given service to the VSPackage's service container.
Explicit interface implemetationPrivate method IServiceContainer.AddService(Type, ServiceCreatorCallback, Boolean) Adds the given service to the service container by means of the specified ServiceCreatorCallback.
Explicit interface implemetationPrivate method IServiceContainer.AddService(Type, Object, Boolean) Infrastructure. Adds the given service to the VSPackage's service container.
Explicit interface implemetationPrivate method IServiceProvider.GetService Gets the service of the specified type.
Explicit interface implemetationPrivate method IServiceContainer.RemoveService(Type) Infrastructure. Removes the given service type from the service container.
Explicit interface implemetationPrivate method IServiceContainer.RemoveService(Type, Boolean) Infrastructure. Removes the given service type from the service container, and optionally promotes the removal of the service to parent service containers.
Explicit interface implemetationPrivate method IOleCommandTarget.Exec Executes a specified command or displays help for a command.
Explicit interface implemetationPrivate method IOleCommandTarget.QueryStatus Queries the object for the status of one or more commands generated by user interface events.
Explicit interface implemetationPrivate method IServiceProvider.QueryService Infrastructure. Internal IServiceProvider implementation.
Explicit interface implemetationPrivate method IVsPackage.Close Infrastructure. Closes and disposes the package.
Explicit interface implemetationPrivate method IVsPackage.GetAutomationObject Infrastructure. Gets an automation-friendly object for this package.
Explicit interface implemetationPrivate method IVsPackage.GetPropertyPage Infrastructure. Proffers access to the Tools menu Options and the property pages of the Customize Toolbox dialog boxes.
Explicit interface implemetationPrivate method IVsPackage.QueryClose Infrastructure. Called to ask the VSPackage if the Visual Studio shell can be closed.
Explicit interface implemetationPrivate method IVsPackage.ResetDefaults Infrastructure. Resets Toolbox defaults.
Explicit interface implemetationPrivate method IVsPackage.SetSite Infrastructure. Initializes the VSPackage in the Visual Studio environment.
Explicit interface implemetationPrivate method IVsPersistSolutionOpts.LoadUserOptions Infrastructure. Loads user options for a given solution.
Explicit interface implemetationPrivate method IVsPersistSolutionOpts.ReadUserOptions Infrastructure. Reads user options for a given solution.
Explicit interface implemetationPrivate method IVsPersistSolutionOpts.SaveUserOptions Infrastructure. Saves user options for a given solution.
Explicit interface implemetationPrivate method IVsPersistSolutionOpts.WriteUserOptions Infrastructure. Writes user options for a given solution.
Explicit interface implemetationPrivate method IVsToolboxItemProvider.GetItemContent Gets an item.
Explicit interface implemetationPrivate method IVsToolWindowFactory.CreateToolWindow Infrastructure. Creates a tool window of the specified type with the specified ID.
Explicit interface implemetationPrivate method IVsUserSettings.ExportSettings This method implements the IVsUserSettings Interface used to manage profiles and import/export settings to XML files.
Explicit interface implemetationPrivate method IVsUserSettings.ImportSettings Retrieves a VSPackage's configuration using the Visual Studio settings mechanism when a user selects the import option of the Import/Export Settings feature on the IDE’s Tools menu. This method is part of the implementation of the IVsUserSettings interface used to manage profiles and import/export settings to XML files.
Explicit interface implemetationPrivate method IVsUserSettingsMigration.MigrateSettings Migrates settings from a previous version.
Explicit interface implemetationPrivate method IVsUserSettingsQuery.NeedExport Determines whether settings have changed and should be re-exported.

Top

Remarks

The Package class provides a managed implementation of several of the most useful VSIP interfaces. You can create the basic functionality of a VSPackage with relatively little code by deriving from the Package class, overriding some of its methods, and attaching registration attribute classes. The Package class does not provide direct registration support, but it can use attribute classes to supply the necessary registration information to external tools such as RegPkg.exe.

The Package class offers the following services by default. (You can replace them by asking the VSPackage for IServiceContainer, removing them, and adding your own services in their place.)

  • Package

    The package offers itself as a service.

  • IServiceContainer

    Provides the ability to add and remove services. Any service added with "promote" set to true is proffered to Visual Studio through IProfferService. This makes the service global to all VSPackages within Visual Studio. (This service is available only if the VSPackage has already been loaded.)

In addition to these services, Package uses the service architecture of Visual Studio to provide access to any service available through the global service provider.

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

IVsPackage

Other Resources

Managed VSPackages

VSPackages and the Managed Package Framework

Registering VSPackages