Share via

IExtensionHeader Interface

  • Article

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 AdditionalElements
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 GlobalScope
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 DataFormats.
Public property Locale The CultureInfo that corresponds to the locale ID (LCID) that is listed in the extension manifest.
Public property LocalizedAdditionalElements
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 ReleaseNotes
Public property ReleaseNotesContent
Public property ReleaseNotesFormat
Public property SupportedFrameworkVersionRange
Public property SystemComponent Specifies whether an extension can be uninstalled.
Public property Tags
Public property Version The version of the extension.

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 VSX Schema for Extensions. For more information about extension deployment in general, see Visual Studio Extension Deployment.

See Also

Reference

Microsoft.VisualStudio.ExtensionManager Namespace