Como criar páginas de opções personalizadas

Os suplementos do Visual Studio foram substituídos no Visual Studio 2013. Você deve atualizar seus suplementos para as extensões VSPackage. Para obter mais informações sobre atualização, consulte Perguntas frequentes: convertendo suplementos em extensões VSPackage.

A caixa de diálogo Opções exibe uma variedade de páginas para diferentes partes do Visual Studio. Você pode controlar as páginas de opções existentes, de acordo com Controlando configurações de Opções, e também pode criar suas próprias páginas personalizadas. Você pode usar páginas personalizadas para permitir que os usuários alterem as configurações para seus suplementos ou outros programas.

Para criar sua própria página Opções personalizada, você não precisa usar um suplemento porque a definição da página é armazenada em um arquivo XML, e não nas chaves do Registro. Portanto, você pode criar páginas de Opções acessíveis no ambiente de desenvolvimento integrado (IDE) do Visual Studio e também em IDE de macros.

As etapas a seguir demonstram como criar um controle de usuário personalizado que atuará como uma página de Opções personalizadas e, em seguida, modificar um arquivo .addin para referenciá-lo.

Dica

As caixas de diálogo e os comandos de menu que você vê podem diferir das descritas no Help dependendo de suas configurações ativas ou de edição.Esses procedimentos foram desenvolvidos com as Configurações Gerais de Desenvolvimento ativas.Para alterar as configurações, clique em Importar e ExportarConfigurações no menu de Ferramentas.Para obter mais informações, consulte Personalizando configurações de desenvolvimento no Visual Studio.

Para criar uma página Opções personalizada

1. Crie um projeto de biblioteca de controle do Windows. Nomeie ToolsOptionsLibrary.dll.

2. Adicione os controles e a funcionalidade desejados.

   Esse controle de usuário se tornará a página personalizada Opções. Redimensione o controle para preencher a área cliente da caixa de diálogo Opções.

3. Crie o projeto.

   Visual Studio procura todos os arquivos compartilhados .addin quando ele é iniciado e carrega os que estão presentes. A página Opções denominada Segurança de macros/suplemento define um conjunto de tokens para caminhos dos arquivos .addin. Os seguintes tokens estão incluídos:

   • %ALLUSERSPROFILE%

   • %APPDATA%

   • %USERPROFILE%

   • %VSAPPDATA%

   • %VSCOMMONAPPDATA%

   Quando Visual Studio começar a procurar por arquivos .addIn, ele substitui esses tokens usando as seguintes cadeias de caracteres de caminho:

   Token	Path
   %ALLUSERSPROFILE%	..\Documents and Settings\All Users\Application Data\Microsoft\MSEnvShared\Addins\
   %APPDATA%	..\Documents and Settings\username\Microsoft\MSEnvShared\Addins\
   %USERPROFILE%	..\Documents and Settings\username\My Documents\Visual Studio 2010\Addins\
   %VSAPPDATA%	..\Documents and Settings\username\Addins\
   %VSCOMMONAPPDATA%	..\Documents and Settings\All Users\Addins

   Para obter mais informações sobre como registrar suplementos, consulte Segurança de Suplemento.

4. Em um dos diretórios listados anteriormente, crie um arquivo .addin para fazer referência à nova página de Opções.

   Você pode usar o seguinte código como um modelo:

   <?xml version="1.0" encoding="UTF-16" standalone="no"?>
   <Extensibility xmlns="https://schemas.microsoft.com/AutomationExtensibility">
       <HostApplication>
           <Name>Microsoft Visual Studio Macros</Name>
           <Version>10.0</Version>
       </HostApplication>
       <HostApplication>
           <Name>Microsoft Visual Studio</Name>
           <Version>10.0</Version>
       </HostApplication>
       <ToolsOptionsPage>
           <Category Name="Environment">
               <SubCategory Name="My Tools Options Page">
                   <Assembly><dll location></Assembly>
                   <FullClassName>ToolsOptionsLibrary.UserControl1
                   </FullClassName>
               </SubCategory>
           </Category>
       </ToolsOptionsPage>
   </Extensibility>
   

5. Na marca de <Assembly></Assembly>, substitua <dll location> usando o caminho de ToolsOptionsLibrary.dll.

6. Altere as configurações de <ToolsOptionsPage> (Nome de Categoria, Nome da Subcategoria etc) para refletir as especificidades do seu controle de usuário.

   Por exemplo, se seu controle de usuário for chamado de “NewPage” e seu projeto de “MyTOLib”, então a marca de FullClassName será MyTOLib.NewPage. O assembly é onde se encontra a DLL de opções. O nome da categoria corresponde ao nó na caixa de diálogo Opções onde você deseja localizar sua página personalizada, por exemplo, Ambiente, Depuração ou Projetos.

   Se você especificar um nome que não existe, um nó que possui esse nome será criado. SubCategory é o nome que aparece sob o nó. Observe que o número máximo de níveis é dois. Você não pode adicionar um nó do terceiro nível.

7. Salve o arquivo como um arquivo de texto que possui a extensão de nome de arquivo .addin em uma das pastas de arquivos de suplementos descritas anteriormente. O diretório padrão é ..\Documents and Settings\username\Application Data\Microsoft\MSEnvShared\Addins\.

   Quando Visual Studio é iniciado, ele procura definições de página de Opções personalizadas nesse diretório e carrega as que encontrar. Você pode alterar ou adicionar diretórios do suplemento usando a página Suplemento / Segurança de Macros sob o nó Ambiente na caixa de diálogo Opções.

8. Inicie o Visual Studio e clique em Opções no menu de Ferramentas.

   A nova página Opções é exibida.

Consulte também

Tarefas

Como alterar características da janela

Conceitos

Controlando configurações de Opções

Registro de suplementos

Gráfico do modelo de objetos automation

Outros recursos

Criando e controlando janelas de ambiente

Referência sobre automação e extensibilidade