IVsPackage Interface

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Initializes a VSPackage in the environment and makes its services available to the environment.

public interface class IVsPackage

public interface class IVsPackage

__interface IVsPackage

[System.Runtime.InteropServices.Guid("D4F3F4B1-E900-4E51-ADB3-D532348F83CB")]
[System.Runtime.InteropServices.InterfaceType(1)]
public interface IVsPackage

[System.Runtime.InteropServices.Guid("D4F3F4B1-E900-4E51-ADB3-D532348F83CB")]
[System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)]
public interface IVsPackage

[<System.Runtime.InteropServices.Guid("D4F3F4B1-E900-4E51-ADB3-D532348F83CB")>]
[<System.Runtime.InteropServices.InterfaceType(1)>]
type IVsPackage = interface

[<System.Runtime.InteropServices.Guid("D4F3F4B1-E900-4E51-ADB3-D532348F83CB")>]
[<System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)>]
type IVsPackage = interface

Public Interface IVsPackage

Derived: Microsoft.VisualStudio.Shell.Package

Attributes: GuidAttribute InterfaceTypeAttribute

Remarks

This interface must be implemented on all VSPackage classes. Visual Studio uses this interface to call on the VSPackage for services it might provide. Most extensions start out by loading a VSPackage, which is sited to the environment. The calling VSPackage is handed a pointer to a service provider.

Notes to Implementers

Implement IVsPackage whenever you initialize a VSPackage.

If a package needs to block shutdown of the IDE it should implement IVsPackage2.

Methods

Close()	Closes the VSPackage, releases cached interface pointers, and unadvises event sinks.
CreateTool(Guid)	Enables the environment to create on-demand tool windows that are implemented by VSPackages.
GetAutomationObject(String, Object)	Enables a VSPackage to participate in the DTE automation object model.
GetPropertyPage(Guid, VSPROPSHEETPAGE[])	Proffers access to the Tools menu Options and the property pages of the Customize Toolbox dialog boxes.
QueryClose(Int32)	Enables a VSPackage that requires user intervention to abort the shutdown process.
ResetDefaults(UInt32)	Resets Toolbox defaults.
SetSite(IServiceProvider)	Initializes a VSPackage with a back pointer to the environment.

Applies to

Share via