ExtensionMetadata Class

Definition

Descriptive information about the extension.

public class ExtensionMetadata : IEquatable<Microsoft.VisualStudio.Extensibility.ExtensionMetadata>
type ExtensionMetadata = class
    interface IEquatable<ExtensionMetadata>
Public Class ExtensionMetadata
Implements IEquatable(Of ExtensionMetadata)
Inheritance
ExtensionMetadata
Implements

Constructors

ExtensionMetadata(ExtensionMetadata)
ExtensionMetadata(String, Version, String, String, String)

Initializes a new instance of the ExtensionMetadata class.

Properties

Description

Gets short description of the package and its contents that is displayed in Extension Manager UI.

DisplayName

Gets the user-friendly package name that is displayed in the Extension Manager UI.

EqualityContract
Icon

Gets the optional relative path to an image file (png, bmp, jpeg, ico) contained in the package. The icon image should be 32x32 pixels (or will be shrunk to that size) and appears in the listview UI. If no Icon element is specified, the UI uses a default.

Id

Gets the unique identifier of the extension.

InstallationTargetArchitecture

Gets the optional Visual Studio architectures supported by this extension. When null, this defaults to the target architecture of the extension project (AnyCpu corresponds to VisualStudioArchitecture.Amd64 | VisualStudioArchitecture.Arm64).

InstallationTargetVersion

Gets the optional Visual Studio version range supported by this extension.

License

Gets the optional relative path to a license file contained in the package (.txt, .rtf).

MoreInfo

Gets the optional URL to a page online that contains a full description of this package.

Preview

Gets a value indicating whether this extension should be labeled as preview on the Visual Studio Marketplace. At this time, this property is set to true by default as the VisualStudio.Extensibility framework is being actively developed and new features are added at a quick pace.

PreviewImage

Gets the optional relative path to an image file (png, bmp, jpeg) contained in the package. The preview image should be 200x200 pixels, and displayed in the details UI. If no PreviewImage is specified, the UI uses a default.

PublisherName

Gets the publisher name of the extension.

ReleaseNotes

Gets the optional relative path to a release notes file contained in the package (.txt, .rtf) or a URL to a website that displays the release notes.

Tags

Gets the optional text tags that are used for search hints.

Version

Gets version of the extension.

Methods

<Clone>$()
Equals(ExtensionMetadata)
Equals(Object)
GetHashCode()
PrintMembers(StringBuilder)
ToString()

Operators

Equality(ExtensionMetadata, ExtensionMetadata)
Inequality(ExtensionMetadata, ExtensionMetadata)

Applies to