Compartilhar via


ProvideMenuResourceAttribute Classe

Definição

Fornece informações de registro sobre os recursos de menu usados em um VSPackage. Essa classe não pode ser herdada.

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
Herança
ProvideMenuResourceAttribute
Atributos

Comentários

Quando chamar

Aplique o ProvideMenuResourceAttribute a uma Microsoft.VisualStudio.Packageclasse ou classe derivada de que implementa IVsPackage se a classe contiver um ou mais recursos de menu. Registre os recursos com regpkg.exe ou uma ferramenta de registro semelhante. Para obter mais informações, consulte Registrando VSPackages.

Uso básico

A ProvideMenuResourceAttribute classe define a ID do recurso e o número de versão de um recurso de menu, permitindo que uma ferramenta de registro, como regpkg.exe, registre o recurso de menu com o Visual Studio. Quando o Visual Studio encontra um VSPackage com um recurso de menu registrado, ele recupera as informações de recurso do VSPackage ou da DLL gerenciada ou satélite do pacote e mescla o menu no sistema de menus do Visual Studio. Para usar ProvideMenuResourceAttribute, coloque-o em uma Packageclasse ou classe derivada de que implementa IVsPackage.

Para que o recurso de menu mescle corretamente, a DLL do recurso deve seguir as convenções de DLL satélite. Ele deve ser nomeado <assemblyfile>UI.dll e colocado em um subdiretório localizado apropriado. Para obter informações adicionais sobre menus e recursos de menu, consulte How VSPackages Add User Interface Elements and Commands, Menus e Toolbars.

Essa classe de atributo só é usada para fornecer dados para ferramentas de registro externas. Ele não tem nenhum efeito sobre o comportamento em tempo de execução do VSPackage.

Observação

C# acrescenta automaticamente a palavra "Atributo" ao nome de qualquer classe de atributo. No código C#, consulte esse atributo como ProvideMenuResource.

Entradas do Registro

  • As seguintes entradas do Registro são criadas por ProvideMenuResourceAttribute:

  • <VSROOT>\Menus\

  • <VSROOT>\Menus\{PackageGuid}=", ResourceID, Version"

Exemplos

Você pode encontrar implementações da ProvideMenuResourceAttribute classe nos exemplos gerenciados. O local padrão para esse e todos os outros atributos usados para registro automático é adjacente à implementação da Package classe em VsPkg.cs, VsPkg.vb ou VsPkg.cpp, dependendo do idioma usado no exemplo.

Construtores

ProvideMenuResourceAttribute(Int16, Int32)

Esse construtor cria um novo objeto ProvideMenuResourceAttribute com a ID do recurso e o número de versão fornecidos.

ProvideMenuResourceAttribute(String, Int32)

Inicializa uma nova instância de ProvideMenuResourceAttribute com a ID e a versão do recurso especificados.

Propriedades

IconMappingFilename

O caminho para um arquivo CSV que mapeia os identificadores de ícone definidos no recurso de menu para monikers de imagem. O caminho é um caminho relativo implicitamente com raiz em $PackageFolder$ou um caminho absoluto explicitamente enraizado em um diretório definido por uma variável de ambiente (por exemplo, "%UserProfile%\dir1\dir2\MyMappingFile.csv").

O formato do arquivo CSV é:

Icon guid, Icon id, Moniker guid, Moniker id
b714fcf7-855e-4e4c-802a-1fd87144ccad,1,fda30684-682d-421c-8be4-650a2967058e,100
{b714fcf7-855e-4e4c-802a-1fd87144ccad},2,{fda30684-682d-421c-8be4-650a2967058e},200
etc...
ResourceID

A propriedade ResourceID retorna o valor da ID do recurso definida no construtor.

TypeId

Substitua a propriedade TypeID para permitir que as classes derivadas de RegistrationAttribute funcionem com System.ComponentModel.TypeDescriptor.GetAttributes(...). Um atributo derivado deste terá que substituir essa propriedade somente se precisar de um controle melhor sobre as instâncias que podem ser aplicadas a uma classe.

(Herdado de RegistrationAttribute)
Version

Retorna o número de versão do recurso de menu.

Métodos

GetPackageRegKeyPath(Guid)

Obtém o caminho do Registro (em relação à raiz do registro do aplicativo) do VSPackage.

(Herdado de RegistrationAttribute)
Register(RegistrationAttribute+RegistrationContext)

Fornece informações de registro sobre um VSPackage quando chamado por uma ferramenta de registro externo, como regpkg.exe. Para obter mais informações, consulte Registrando VSPackages.

Unregister(RegistrationAttribute+RegistrationContext)

Chamado para cancelar o registro desse atributo com o contexto determinado.

Aplica-se a