DefaultRegistryRootAttribute Class

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell

Assembly:: Microsoft.VisualStudio.Shell.14.0.dll

Assembly:: Microsoft.VisualStudio.Shell.15.0.dll

Package:: Microsoft.VisualStudio.Shell.15.0 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.

Defines the default registry root used to register VSPackage information. This class cannot be inherited.

public ref class DefaultRegistryRootAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=false, Inherited=true)]
public sealed class DefaultRegistryRootAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=false, Inherited=true)>]
type DefaultRegistryRootAttribute = class
    inherit Attribute

Public NotInheritable Class DefaultRegistryRootAttribute
Inherits Attribute

Inheritance: Attribute
DefaultRegistryRootAttribute

Attributes: AttributeUsageAttribute

Remarks

Important

Packages that target Visual Studio 2010 only do not need a package load key.

Packages that target Visual Studio 2008 and earlier must have a package load key in order to validate and load VSPackages.

When to Call

For packages that target Visual Studio 2008 or earlier, apply the attribute DefaultRegistryRootAttribute to your Package-derived class or class that implements IVsPackage to define the default registry root for the package.

Basic Usage

This attribute should be applied to classes implementing the Package class and needing to use an alternate registry root. If not present, the default registry root will be used and this may prevent the package from functioning. The base Package class already provides this attribute for the version of Visual Studio that the package was built for.

The value of the attribute must be a fully qualified registry root, such as Software\Microsoft\VisualStudio\8.0. External registration tools can override the default registry root with their own custom root.

This attribute class is only used to provide data for external registration tools. It does not have any effect on the runtime behavior of the VSPackage. To use DefaultRegistryRootAttribute, place it on class that is derived from Package or that implements IVsPackage.

Constructors

DefaultRegistryRootAttribute(String)

Initializes a new DefaultRegistryRootAttribute object with the given registry root.

Properties

Root	Gets the value of the default registry root for the VSPackage.

Applies to

Share via