Share via


IExtensionHeader Interface

Represents all of the metadata that is contained in the Identifier element of a VSIX manifest.

Namespace:  Microsoft.VisualStudio.ExtensionManager
Assembly:  Microsoft.VisualStudio.ExtensionManager (in Microsoft.VisualStudio.ExtensionManager.dll)

Syntax

'Declaration
Public Interface IExtensionHeader
public interface IExtensionHeader
public interface class IExtensionHeader
type IExtensionHeader =  interface end
public interface IExtensionHeader

The IExtensionHeader type exposes the following members.

Properties

  Name Description
Public property AllUsers
Public property Author The person or company who created the extension.
Public property Description A description of the extension.
Public property GettingStartedGuide A location that provides information about how to use the extension.
Public property Icon Path of an icon file that represents the extension.
Public property Identifier A unique value to identify the extension.
Public property InstalledByMsi Denotes whether the extension was installed by a Windows Installer (.msi) file. These extensions cannot be uninstalled through Extension Manager. Instead, they must be uninstalled by using the uninstall programs section of the Windows Control Panel.
Public property License The path of a license file.
Public property LicenseClickThrough Specifies whether a License Agreement dialog box must be shown before the extension is installed.
Public property LicenseFormat The data format of a license. Corresponds to a field value from System.Windows.DataFormats.
Public property Locale The CultureInfo that corresponds to the locale ID (LCID) that is listed in the extension manifest.
Public property LocalizedDescription
Public property LocalizedName
Public property MoreInfoUrl A location that provides more information about the extension.
Public property Name The name of the extension.
Public property PreviewImage The path of an image file that shows the purpose of the extension.
Public property SupportedFrameworkMaxVersion The latest version of the .NET Framework that the extension supports.
Public property SupportedFrameworkMinVersion The earliest version of the .NET Framework that the extension supports.
Public property SupportedIsolatedShellVersions A collection of Visual Studio Isolated Shell versions that are supported by the extension.
Public property SupportedVSVersions A collection of all Visual Studio versions that are supported by the extension.
Public property SystemComponent Specifies whether an extension can be uninstalled.
Public property Version The version of the extension.

Top

Methods

  Name Description
Public method GetSupportedIsolatedShells A collection of Visual Studio Isolated Shell applications that are supported for a given Visual Studio Isolated Shell version.
Public method GetSupportedVSEditions A collection of Visual Studio editions that are supported for a given Visual Studio version.
Public method IsIsolatedShellSupported Determines whether the extension may be installed in a given Visual Studio Shell application.
Public method IsVSEditionSupported Determines whether the extension may be installed in a given version of Visual Studio.

Top

Remarks

Although this API supports the Extension Manager infrastructure, we recommend that you do not use it because it is subject to change.

For more information about VSIX manifests, see VSIX Extension Schema Reference. For more information about extension deployment in general, see Visual Studio Extension Deployment.

See Also

Reference

Microsoft.VisualStudio.ExtensionManager Namespace