ProvideMenuResourceAttribute Classe
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Fournit les informations d'inscription sur les ressources de menu utilisées dans un VSPackage. Cette classe ne peut pas être héritée.
public ref class ProvideMenuResourceAttribute sealed : Microsoft::VisualStudio::Shell::RegistrationAttribute
public ref class ProvideMenuResourceAttribute sealed : Microsoft::VisualStudio::Shell::RegistrationAttribute
[System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=true, Inherited=true)]
public sealed class ProvideMenuResourceAttribute : Microsoft.VisualStudio.Shell.RegistrationAttribute
[<System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=true, Inherited=true)>]
type ProvideMenuResourceAttribute = class
inherit RegistrationAttribute
Public NotInheritable Class ProvideMenuResourceAttribute
Inherits RegistrationAttribute
- Héritage
- Attributs
Remarques
Quand appeler
Appliquez le ProvideMenuResourceAttribute à une Microsoft.VisualStudio.Packageclasse dérivée qui implémente IVsPackage si la classe contient une ou plusieurs ressources de menu. Inscrivez les ressources avec regpkg.exe ou un outil d’inscription similaire. Pour plus d’informations, consultez Inscription de VSPackages.
Utilisation de base
La ProvideMenuResourceAttribute
classe définit l’ID de ressource et le numéro de version d’une ressource de menu, ce qui permet à un outil d’inscription tel que regpkg.exe d’inscrire la ressource de menu auprès de Visual Studio. Lorsque Visual Studio rencontre un VSPackage avec une ressource de menu inscrite, il récupère les informations de ressource à partir du VSPackage ou de la DLL managée ou satellite du package et fusionne le menu dans le système de menus Visual Studio. Pour utiliser ProvideMenuResourceAttribute
, placez-le sur une Package
classe dérivée ou une classe qui implémente IVsPackage
.
Pour que la ressource de menu soit fusionnée correctement, la DLL de ressource doit suivre les conventions DE DLL satellite. Il doit être nommé <assemblyfile>UI.dll et placé dans un sous-répertoire localisé approprié. Pour plus d’informations sur les menus et les ressources de menu, consultez How VSPackages Add User Interface Elements and Commands, Menus et Toolbars.
Cette classe d’attribut est utilisée uniquement pour fournir des données pour les outils d’inscription externes. Elle n’a aucun effet sur le comportement au moment de l’exécution du VSPackage.
Notes
C# ajoute automatiquement le mot « Attribute » au nom de n’importe quelle classe d’attribut. Dans le code C#, reportez-vous à cet attribut en tant que ProvideMenuResource
.
Entrées de Registre
Les entrées de Registre suivantes sont créées par
ProvideMenuResourceAttribute
:<VSROOT>\Menus\
<VSROOT>\Menus\{PackageGuid}= », ResourceID, Version »
Exemples
Vous trouverez les implémentations de la ProvideMenuResourceAttribute classe dans les exemples managés. L’emplacement standard de ce attribut et de tous les autres attributs utilisés pour l’inscription automatique est adjacent à l’implémentation de la Package classe dans VsPkg.cs, VsPkg.vb ou VsPkg.cpp, selon la langue utilisée dans l’exemple.
Constructeurs
ProvideMenuResourceAttribute(Int16, Int32) |
Ce constructeur crée un objet ProvideMenuResourceAttribute avec l’ID de ressource et le numéro de version donnés. |
ProvideMenuResourceAttribute(String, Int32) |
Initialise une nouvelle instance de ProvideMenuResourceAttribute avec l'ID de ressource et la version spécifiés. |
Propriétés
IconMappingFilename |
Chemin d’accès à un fichier CSV qui mappe les identificateurs d’icône définis dans la ressource de menu à des monikers d’image. Le chemin d’accès est soit un chemin relatif implicitement enraciné à $PackageFolder$, soit un chemin absolu explicitement enraciné dans un répertoire défini par une variable d’environnement (par exemple, « %UserProfile%\dir1\dir2\MyMappingFile.csv »). Le format du fichier CSV est le suivant :
|
ResourceID |
La propriété ResourceID retourne la valeur de l’ID de ressource défini dans le constructeur. |
TypeId |
Remplacez la propriété TypeID afin de permettre aux classes dérivées RegistrationAttribute de fonctionner avec System.ComponentModel.TypeDescriptor.GetAttributes (...). Un attribut dérivé de celui-ci doit remplacer cette propriété uniquement s’il a besoin d’un meilleur contrôle sur les instances qui peuvent être appliquées à une classe. (Hérité de RegistrationAttribute) |
Version |
Retourne le numéro de version de la ressource menu. |
Méthodes
GetPackageRegKeyPath(Guid) |
Obtient le chemin d'accès au Registre (relatif à la racine de Registre de l'application) du VSPackage. (Hérité de RegistrationAttribute) |
Register(RegistrationAttribute+RegistrationContext) |
Fournit des informations d'inscription sur un VSPackage appelé par un outil d'inscription externe tel que regpkg.exe. Pour plus d’informations, consultez Inscription de VSPackages. |
Unregister(RegistrationAttribute+RegistrationContext) |
Appelé pour annuler l'inscription de cet attribut avec le contexte donné. |