ProvideAutoLoadAttribute Class

Definition

Apply this attribute to your VSPackage class to cause it to be automatically loaded when a specified UI context is active. This class cannot be inherited.

public ref class ProvideAutoLoadAttribute sealed : Microsoft::VisualStudio::Shell::RegistrationAttribute
public ref class ProvideAutoLoadAttribute sealed : Microsoft::VisualStudio::Shell::RegistrationAttribute
[System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=true, Inherited=true)]
public sealed class ProvideAutoLoadAttribute : Microsoft.VisualStudio.Shell.RegistrationAttribute
type ProvideAutoLoadAttribute = class
    inherit RegistrationAttribute
Public NotInheritable Class ProvideAutoLoadAttribute
Inherits RegistrationAttribute
Inheritance
ProvideAutoLoadAttribute
Attributes

Remarks

Apply this attribute to your VSPackage class that inherits from Package or implements IVsPackage to cause your class to be automatically loaded when a specified UI context is active.

This attribute makes your VSPackage an extender (an object which implements IExtenderProvider). The GUID passed to the constructor determines the context in which the package loads.

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.

Note

Visual C# automatically appends the word "Attribute" to the name of any attribute class. In Visual C# code, refer to this attribute as ProvideAutoLoad.

Note

The GUIDs for the Visual C# and Visual Basic project types are {FAE04EC0-301F-11D3-BF4B-00C04F79EFBC} and {F184B08F-C81C-45F6-A57F-5ABD9991F28F}, respectively.

Registry Entries

The following registry entries are created by ProvideAutoLoadAttribute:

  • <VSROOT>\AutoLoadPackages\{ContextGuid}

  • <VSROOT>\AutoLoadPackages\{ContextGuid}\{PackageGuid}=0

Constructors

ProvideAutoLoadAttribute(String)

Returns a new instance of this attribute with the specified cmdUiContextGuid.

ProvideAutoLoadAttribute(String, PackageAutoLoadFlags)

Initializes a new instance of ProvideAutoloadAttribute in the specified UI context with the specified options.

Properties

Flags

Gets the autoload options.

LoadGuid

Returns the UI context GUID which will cause your package to load.

TypeId

Override the TypeID property in order to let the RegistrationAttribute derived classes to work with System.ComponentModel.TypeDescriptor.GetAttributes(...). An attribute derived from this one will have to override this property only if it needs a better control on the instances that can be applied to a class.

(Inherited from RegistrationAttribute)

Methods

GetPackageRegKeyPath(Guid)

Gets the registry path (relative to the registry root of the application) of the VSPackage.

(Inherited from RegistrationAttribute)
Register(RegistrationAttribute+RegistrationContext)

Provides registration information about a VSPackage when called by an external registration tool like regpkg.exe.

Unregister(RegistrationAttribute+RegistrationContext)

Removes registration information about a VSPackage when called by an external registration tool like regpkg.exe.

Applies to