Share via


Package Members

Include Protected Members
Include Inherited Members

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

The Package type exposes the following members.

Constructors

 

Name

Description

Protected method

Package

Initializes a new instance of Package.

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.

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 a hash function for a particular type. (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.

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

Overloaded. Parses a toolbox resource format and adds the toolbox items 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

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

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

Public method

AddService

Overloaded.

Explicit interface implemetationPrivate method

IVsPackage.Close

Infrastructure. Closes and disposes the package.

Explicit interface implemetationPrivate method

IVsToolWindowFactory.CreateToolWindow

Infrastructure. Creates a tool window of the specified type with the specified ID.

Explicit interface implemetationPrivate method

IOleCommandTarget.Exec

Executes a specified command or displays help for a command.

Explicit interface implemetationPrivate method

IVsUserSettings.ExportSettings

Infrastructure. This method implements the IVsUserSettings Interface used to manage profiles and import/export settings to XML files.

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

IServiceProvider.GetService

Gets the service of the specified type.

Explicit interface implemetationPrivate method

IVsUserSettings.ImportSettings

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

IVsPersistSolutionOpts.LoadUserOptions

Infrastructure. Loads user options for a given solution.

Explicit interface implemetationPrivate method

IVsUserSettingsMigration.MigrateSettings

Explicit interface implemetationPrivate method

IVsPackage.QueryClose

Infrastructure. Called to ask the VSPackage if the Visual Studio shell can be closed.

Explicit interface implemetationPrivate method

IServiceProvider.QueryService

Infrastructure. Internal IServiceProvider implementation.

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

IVsPersistSolutionOpts.ReadUserOptions

Infrastructure. Reads user options for a given solution.

Public method

RemoveService

Infrastructure. Overloaded.

Explicit interface implemetationPrivate method

IVsPackage.ResetDefaults

Infrastructure. Resets Toolbox defaults.

Explicit interface implemetationPrivate method

IVsPersistSolutionOpts.SaveUserOptions

Infrastructure. Saves user options for a given solution.

Explicit interface implemetationPrivate method

IVsPackage.SetSite

Infrastructure. Initializes the VSPackage in the Visual Studio environment.

Explicit interface implemetationPrivate method

IVsPersistSolutionOpts.WriteUserOptions

Infrastructure. Writes user options for a given solution.

Top

See Also

Reference

Package Class

Microsoft.VisualStudio.Shell Namespace