RegisterAutoLoadAttribute Class

Artigo
04/29/2015

Note: This API is now obsolete.

Registers the VSPackage as an extender that is automatically loaded in response to a particular context GUID. This class cannot be inherited.

Inheritance Hierarchy

Object
  Attribute
    Microsoft.VisualStudio.Shell.RegistrationAttribute
      Microsoft.VisualStudio.Shell.RegisterAutoLoadAttribute

Namespace: Microsoft.VisualStudio.Shell
Assembly: Microsoft.VisualStudio.Shell.12.0 (in Microsoft.VisualStudio.Shell.12.0.dll)

Syntax

'Declaration
<ObsoleteAttribute("RegisterAutoLoadAttribute has been deprecated. Please use ProvideAutoLoadAttribute instead.")> _
<AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple := True, Inherited := True)> _
Public NotInheritable Class RegisterAutoLoadAttribute _
    Inherits RegistrationAttribute

[ObsoleteAttribute("RegisterAutoLoadAttribute has been deprecated. Please use ProvideAutoLoadAttribute instead.")]
[AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple = true, Inherited = true)]
public sealed class RegisterAutoLoadAttribute : RegistrationAttribute

[ObsoleteAttribute(L"RegisterAutoLoadAttribute has been deprecated. Please use ProvideAutoLoadAttribute instead.")]
[AttributeUsageAttribute(AttributeTargets::Class, AllowMultiple = true, Inherited = true)]
public ref class RegisterAutoLoadAttribute sealed : public RegistrationAttribute

[<Sealed>]
[<ObsoleteAttribute("RegisterAutoLoadAttribute has been deprecated. Please use ProvideAutoLoadAttribute instead.")>]
[<AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple = true, Inherited = true)>]
type RegisterAutoLoadAttribute =  
    class 
        inherit RegistrationAttribute 
    end

public final class RegisterAutoLoadAttribute extends RegistrationAttribute

The RegisterAutoLoadAttribute type exposes the following members.

Constructors

	Name	Description
	RegisterAutoLoadAttribute	Creates a new RegisterAutoLoadAttribute object and saves the GUID of the package that initiated package loading.

Top

Properties

	Name	Description
	LoadGuid	Returns the context GUID that triggers package load.
	TypeId	Gets the current instance of this attribute. (Inherited from RegistrationAttribute.)

Top

Methods

	Name	Description
	Equals	Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
	GetHashCode	Returns the hash code for this instance. (Inherited from Attribute.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsDefaultAttribute	When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
	Match	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
	Register	Provides registration information about a VSPackage when called by an external registration tool such as RegPkg.exe. (Overrides RegistrationAttribute.Register(RegistrationAttribute.RegistrationContext).)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Unregister	Removes registration information about a VSPackage when called by an external registration tool such as RegPkg.exe. (Overrides RegistrationAttribute.Unregister(RegistrationAttribute.RegistrationContext).)

Top

Explicit Interface Implementations

	Name	Description
	System#Runtime#InteropServices#_Attribute#GetIDsOfNames	Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
	System#Runtime#InteropServices#_Attribute#GetTypeInfo	Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
	System#Runtime#InteropServices#_Attribute#GetTypeInfoCount	Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
	System#Runtime#InteropServices#_Attribute#Invoke	Provides access to properties and methods exposed by an object. (Inherited from Attribute.)

Top

Remarks

Basic Usage

RegisterAutoLoadAttribute registers the VSPackage as an extender (an object which implements IExtenderProvider. The GUID passed to the constructor determines the context in which the package loads. To use RegisterAutoLoadAttribute, place it on a package class, such as Package or a class that implements IVsPackage.

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 RegisterAutoLoad.

Note

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

Registry Entries

The following registry entries are created by RegisterAutoLoadAttribute:

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

Samples

You can find implementations of the RegisterAutoLoadAttribute class in the managed samples. The standard location for this and all other attributes used for automatic registration is adjacent to the implementation of the Package class in VsPkg.cs, VsPkg.vb, or VsPkg.cpp, depending on the language used in the sample.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Compartilhar via