ProvideMenuResourceAttribute Class

Artículo
04/29/2015

Provides registration information about menu resources used in a VSPackage. This class cannot be inherited.

Inheritance Hierarchy

Object
  Attribute
    Microsoft.VisualStudio.Shell.RegistrationAttribute
      Microsoft.VisualStudio.Shell.ProvideMenuResourceAttribute

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

Syntax

'Declaration
<AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple := True, Inherited := True)> _
Public NotInheritable Class ProvideMenuResourceAttribute _
    Inherits RegistrationAttribute

[AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple = true, Inherited = true)]
public sealed class ProvideMenuResourceAttribute : RegistrationAttribute

[AttributeUsageAttribute(AttributeTargets::Class, AllowMultiple = true, Inherited = true)]
public ref class ProvideMenuResourceAttribute sealed : public RegistrationAttribute

[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple = true, Inherited = true)>]
type ProvideMenuResourceAttribute =  
    class 
        inherit RegistrationAttribute 
    end

public final class ProvideMenuResourceAttribute extends RegistrationAttribute

The ProvideMenuResourceAttribute type exposes the following members.

Constructors

	Name	Description
	ProvideMenuResourceAttribute(Int16, Int32)	This constructor creates a new ProvideMenuResourceAttribute object with the given resource ID and version number.
	ProvideMenuResourceAttribute(String, Int32)	Initializes a new instance of ProvideMenuResourceAttribute with the specified resource ID and version.

Top

Properties

	Name	Description
	ResourceID	The ResourceID property returns the value of the resource ID set in the constructor.
	TypeId	Gets the current instance of this attribute. (Inherited from RegistrationAttribute.)
	Version	Returns the version number of the menu resource.

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. For more information, see Registering VSPackages. (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. For more information, see Registering VSPackages. (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

When to Call

Apply the ProvideMenuResourceAttribute to a Microsoft.VisualStudio.Package-derived class or class that implements IVsPackage if the class contains one or more menu resources. Register the resources with regpkg.exe or a similar registration tool. For more information, see Registering VSPackages.

Basic Usage

The ProvideMenuResourceAttribute class defines the resource ID and version number of a menu resource, allowing a registration tool such as regpkg.exe to register the menu resource with Visual Studio. When Visual Studio encounters a VSPackage with a registered menu resource, it retrieves the resource information from the VSPackage or the package's managed or satellite DLL and merges the menu into the Visual Studio menu system. To use ProvideMenuResourceAttribute, place it on a Package-derived class or class that implements IVsPackage.

For the menu resource to merge correctly, the resource DLL must follow the satellite DLL conventions. It must be named <assemblyfile>UI.dll, and placed into an appropriate, localized subdirectory. For additional information on menus and menu resources, see How VSPackages Add User Interface Elements to the IDE and Commands, Menus, and Toolbars.

This attribute class is only used to provide data for external registration tools. It does not have any effect on the run-time behavior of the VSPackage.

Note

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

Registry Entries

The following registry entries are created by ProvideMenuResourceAttribute:
<VSROOT>\Menus\
<VSROOT>\Menus\{PackageGuid}=", ResourceID, Version"

Samples

You can find implementations of the ProvideMenuResourceAttribute 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.

Compartir a través de