Export (0) Print
Expand All
0 out of 1 rated this helpful - Rate this topic

ProvideAutoLoadAttribute Class

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.

Namespace: Microsoft.VisualStudio.Shell
Assembly: Microsoft.VisualStudio.Shell (in microsoft.visualstudio.shell.dll)

[AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple=true, Inherited=true)] 
public sealed class ProvideAutoLoadAttribute : RegistrationAttribute
/** @attribute AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple=true, Inherited=true) */ 
public final class ProvideAutoLoadAttribute extends RegistrationAttribute
AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple=true, Inherited=true) 
public final class ProvideAutoLoadAttribute extends RegistrationAttribute

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.

NoteNote

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

NoteNote

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

Samples

You can find use of the ProvideAutoLoadAttribute class in the managed AutoExtender Sample (C#). The standard location for this and all other attributes used for automatic registration is adjacent to the implementation of the package class.

System.Object
   System.Attribute
     Microsoft.VisualStudio.Shell.RegistrationAttribute
      Microsoft.VisualStudio.Shell.ProvideAutoLoadAttribute
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.