Compartilhar via

Suporte para configurações de usuário

Um VSPackage pode definir uma ou mais categorias de configurações, que são grupos de variáveis de estado que persistem quando um usuário escolhe o comando Importar/Exportar Configurações no menu Ferramentas . Para habilitar essa persistência, use as APIs de configurações no SDK do Visual Studio.

Uma entrada do Registro que é conhecida como um Ponto de Configurações Personalizadas e um GUID define a categoria de configurações de um VSPackage. Um VSPackage pode dar suporte a várias categorias de configurações, cada uma definida por um Ponto de Configurações Personalizadas.

  • As implementações de configurações baseadas em assemblies de interoperabilidade (usando a interface IVsUserSettings) devem criar um Ponto de Configurações Personalizadas, quer editando o registro ou usando um script do Registrador (arquivo .rgs). Para obter mais informações, consulte Criando scripts de registrador.

  • O código que usa o MPF (Managed Package Framework) deve criar Pontos de Configurações Personalizadas anexando um ProvideProfileAttribute ao VSPackage para cada ponto de configurações personalizadas.

    Se um único VSPackage der suporte a vários Pontos de Configurações Personalizadas, cada Ponto de Configurações Personalizadas será implementado por uma classe separada e cada um será registrado por uma instância exclusiva da ProvideProfileAttribute classe. Consequentemente, uma classe de implementação de configurações pode dar suporte a mais de uma categoria de configurações.

Detalhes da entrada do Registro de Ponto de Configurações Personalizadas

Os Pontos de Configurações Personalizadas são criados em uma entrada do Registro no seguinte local: HKLM\Software\Microsoft\VisualStudio\<Version>\UserSettings\<CSPName>, onde <CSPName> é o nome do ponto de configurações personalizadas que o VSPackage dá suporte e <a versão> é a versão do Visual Studio, por exemplo 8.0.

Observação

O caminho raiz de HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\VisualStudio\<Versão> pode ser substituído por uma raiz alternativa quando o IDE (ambiente de desenvolvimento integrado) do Visual Studio é inicializado. Para obter mais informações, consulte Command-Line Switches.

A estrutura da entrada do Registro é ilustrada abaixo:

HKLM\Software\Microsoft\VisualStudio\<Version>\UserSettings\

<CSPName >= s '#12345'

Pacote = '{XXXXXX XXXX XXXX XXXX XXXXXXX}'

Categoria = '{YYYYYY YYYY YYYY YYYY YYYYYYYYY}'

ResourcePackage = '{ZZZZZZ ZZZZ ZZZZ ZZZZ ZZZZZZZZZ}'

AlternateParent = CategoryName

Nome Tipo Dados Description
(Padrão) REG_SZ Nome do ponto de configurações personalizadas O nome da chave, <CSPName>, é o nome não localizado do Ponto de Configurações Personalizadas.

Para implementações com base no MPF, o nome da chave é obtido combinando os argumentos categoryName e objectName do construtor ProvideProfileAttribute em categoryName_objectName.

A chave pode estar vazia ou pode conter a ID de referência para a cadeia de caracteres localizada em uma DLL satélite. Esse valor é obtido do objectNameResourceID argumento para o ProvideProfileAttribute construtor.
Package REG_SZ GUID O GUID do VSPackage que implementa o Ponto de Configurações Personalizadas.

Implementações baseadas no MPF usando a classe ProvideProfileAttribute, usem o argumento do construtor objectType que contém o Type do VSPackage e reflexão para obter esse valor.
Categoria REG_SZ GUID GUID identificando a categoria de configurações.

Para implementações baseadas em assemblies de interoperabilidade, esse valor pode ser um GUID escolhido arbitrariamente, que o IDE do Visual Studio passa para os métodos ExportSettings e ImportSettings. Todas as implementações desses dois métodos devem verificar seus argumentos GUID.

Para implementações com base no MPF, esse GUID é obtido pela Type classe que implementa o mecanismo de configurações do Visual Studio.
ResourcePackage REG_SZ GUID Optional.

Caminho para a DLL satélite que contém cadeias de caracteres localizadas caso o VSPackage em implementação não as forneça.

O MPF usa reflexão para obter o recurso correto VSPackage, de modo que a ProvideProfileAttribute classe não define esse argumento.
AlternateParent REG_SZ Nome da pasta na página Opções de Ferramentas que contém esse Ponto de Configurações Personalizadas. Optional.

Você deve definir esse valor somente se uma implementação de configurações der suporte a páginas de Opções de Ferramentas que usam o mecanismo de persistência no SDK do Visual Studio em vez do mecanismo no modelo de automação para salvar o estado.

Nesses casos, o valor na chave AlternateParent é a seção topic da cadeia topic.sub-topic usada para identificar a página específica ToolsOptions. Por exemplo, para a página "TextEditor.Basic", o valor de AlternateParent seria "TextEditor".

Quando ProvideProfileAttribute gera o Ponto de Configurações Personalizadas, ele é o mesmo que o nome da categoria.
  • Last updated on