Compartilhar via

Adicionando assistentes às caixas de diálogo Adicionar Item e Novo Projeto usando arquivos .Vsdir

  • Artigo

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.

Um arquivo VSDir é um arquivo de texto com a extensão .vsdir que você cria para fornecer informações sobre como exibir seus itens nas caixas de diálogo Adicionar Item e Novo Projeto . As informações incluem os nomes dos itens, a ordem na qual eles aparecem e o ícone exibido com eles. Você pode alterar qualquer um desses itens. Os arquivos de VSDir são usados para adicionar novos modelos ou assistentes às caixas de diálogo Adicionar Item e Novo Projeto.

Não há nenhum arquivo VSDir padrão. Se um estiver presente, o Visual Studio o lê e adiciona seu conteúdo às caixas de diálogo. Se não estiver presente, os modelos e assistentes padrão serão exibidos. Você pode ter vários arquivos VSDir em um único diretório e todos os seus conteúdos serão adicionados às caixas de diálogo. Normalmente, um único arquivo VSDir contém registros para vários assistentes, pastas e modelos. Cada registro no arquivo é separado por um caractere de nova linha. Os caracteres de pipe (|) separam os campos em cada registro. Qualquer campo opcional que não precisa ter dados significativos contém um 0 (zero) ou um espaço como espaço reservado. As cadeias de caracteres inseridas nos campos não precisam ficar entre aspas.

Componentes do arquivo VSDir

Os arquivos VSDir de exemplo são os seguintes. O primeiro referencia um único assistente, aquele que foi criado no tópico Instruções passo a passo: criando um assistente:

MyNewWizard.vsz| |A New Wizard|1|My New Wizard|C:\Addins\MyNewWizard\MyNewWizard\bin\Debug| | |MyNewWizard99

O próximo exemplo de arquivo VSDir faz referência a vários arquivos .vsz do assistente, juntamente com outras informações pertinentes relacionadas a cada assistente (conforme descrito mais adiante neste tópico). Eles são diferentes do arquivo VSDir anterior no qual eles fazem referências às cadeias de caracteres como números de ID de recurso, não como cadeias de caracteres literais. Além disso, usa GUIDs para fazer referência a DLLs.

..\..\Projects\csharp building blocks\BusinessFacade.vsz|{AE77B8D0-6BDC-11d2-B354-0000F81F0C06}|#5015|10|#5022|{AE77B8D0-6BDC-11d2-B354-0000F81F0C06}|127|0|Project
..\..\Projects\csharp building blocks\BusinessRules.vsz|{AE77B8D0-6BDC-11d2-B354-0000F81F0C06}|#5016|20|#5023|{AE77B8D0-6BDC-11d2-B354-0000F81F0C06}|128|0|Project
..\..\Projects\csharp building blocks\DataAccess.vsz|{AE77B8D0-6BDC-11d2-B354-0000F81F0C06}|#5017|30|#5024|{AE77B8D0-6BDC-11d2-B354-0000F81F0C06}|129|0|Project
..\..\Projects\csharp building blocks\SystemFrameworks.vsz|{AE77B8D0-6BDC-11d2-B354-0000F81F0C06}|#5018|40|#5025|{AE77B8D0-6BDC-11d2-B354-0000F81F0C06}|130|0|Project
..\..\Projects\csharp building blocks\WebService.vsz|{AE77B8D0-6BDC-11d2-B354-0000F81F0C06}|#5019|50|#5026|{FAE04EC1-301F-11d3-BF4B-00C04F79EFBC}|4547|1|WebService|Web
..\..\Projects\csharp building blocks\WebUI.vsz|{AE77B8D0-6BDC-11d2-B354-0000F81F0C06}|#5020|60|#5027|{AE77B8D0-6BDC-11d2-B354-0000F81F0C06}|131|1|WebUI|web
..\..\Projects\csharp building blocks\WinUI.vsz|{AE77B8D0-6BDC-11d2-B354-0000F81F0C06}|#5021|70|#5028|{AE77B8D0-6BDC-11d2-B354-0000F81F0C06}|132|0|Project

Os campos a seguir podem ser especificados para cada registro em um arquivo VSDir:

Campo

Significado

RelPathName

Obrigatório. O nome do arquivo .vsz do assistente, como MyWizard.vsz, relativo ao diretório de instalação do Visual Studio.

{clsidPackage}

Opcional. GUID que representa um produto (como Visual C++) que tem uma DLL que contém recursos localizados. Normalmente, este campo fica em branco para os arquivos de VSDir que correspondem com assistentes de terceiros.

LocalizedName

Opcional. Esse é o nome localizável do assistente ou modelo e o nome que aparece na caixa de diálogo Adicionar Item. Pode ser uma cadeia de caracteres ou um identificador de recurso do formulário #ResID.

SortPriority

Obrigatório. Um número inteiro que representa a ordem de classificação e a prioridade relativa, com 1 sendo o mais alto. Por exemplo, se o item for "1", então isso será exibido próximo ao outro 1s e antes de qualquer 2s ou mais baixo.

Descrição

Obrigatório. Uma descrição localizável do modelo ou do assistente que aparecerá na caixa de diálogo Adicionar Item quando o item for selecionado. Pode ser uma cadeia de caracteres ou um identificador de recurso do formulário #ResID. Aplica-se somente aos arquivos de modelo, não a pastas.

DLLPath ou {clsidPackage}

Obrigatório. Especifica um caminho completo de um arquivo DLL ou do EXE, ou um GUID de um produto que tenha um arquivo .dll que contém um ícone para carregar para o assistente. O ícone é carregado como um recurso fora de um arquivo DLL/EXE usando o IconResourceId fornecido. Essa configuração substitui {clsidPackage}, se especificada, para o local de ícone. Aplica-se somente aos arquivos de modelo, não a pastas.

IconResourceId

Opcional. Um identificador do recurso no arquivo DLL que determina o ícone para exibição. Se nenhum ícone for definido, o ambiente substitui o ícone padrão por um arquivo com a mesma extensão que o item. Aplica-se somente aos arquivos de modelo, não a pastas.

Sinalizadores

Opcional. Consulte a descrição Flags e a tabela abaixo. Aplica-se somente aos arquivos de modelo, não a pastas.

SuggestedBaseName

Obrigatório. O nome padrão para o assistente, exibido no campo Nome na caixa de diálogo. Pode ser uma cadeia de caracteres ou um identificador de recurso do formulário #ResID. Se o nome não for exclusivo, o ambiente acrescentará o nome com um número inteiro. Por exemplo, MyFile.aspx pode ser alterado para MyFile1.aspx. Se nenhum nome for fornecido, então “Project” será usado. Aplica-se somente aos arquivos de modelo, não a pastas.

  • Notas
    Qualquer campo que não precisa ter dados significativos deve conter um 0 (zero) como espaço reservado.

    Se nenhum nome localizado for fornecido, o caminho relativo será usado.

    Se nenhum ícone for definido, a IDE substitui o ícone padrão por um arquivo com a mesma extensão.

    Se nenhum nome de base sugerido for fornecido, "Project" será usado.

  • Sinalizadores
    Um grupo de sinalizadores de bit a bit usado para ativar ou desativar os campos Nome e Local na caixa de diálogo Adicionar Item. Isto é, quando o usuário seleciona Adicionar Novo Item no menu Adicionar, o projeto determina se o nome e o local serão exibidos no painel Modelos, mas os sinalizadores determinam se o nome e local estarão disponíveis para o usuário.

    Defina o valor de Flags para a soma dos valores individuais. Isto é, 33 são equivalentes a VSDIRFLAG_NonLocalTemplate | VSDIRITEM_DisableLocationField.

    Nome do sinalizador

    Valor decimal

    Descrição

    VSDIRFLAG_NonLocalTemplate

    1

    Use o comportamento da interface do usuário não local e salve mecanismos.

    VSDIRFLAG_BlankSolution

    2

    Crie uma solução (vazia) em branco. Não crie um projeto.

    VSDIRFLAG_DisableBrowseButton

    4

    Desativar o botão Procurar para este projeto ou item.

    VSDIRFLAG_DontAddDefExtension

    8

    Não anexe uma extensão padrão ao nome fornecido para o item. (Essa configuração é inválida para projetos.)

    VSDIRFLAG_DisableLocationField

    32

    Desativar o campo de localização para este projeto ou item.

    VSDIRFLAG_DontInitNameField

    4096

    Não inicialize o campo de nome para este projeto ou item com um nome válido.

    VSDIRFLAG_DisableNameField

    8192

    Desativar o campo de nome para este projeto ou item.

Consulte também

Tarefas

Como criar um suplemento

Instruções passo a passo: criando um assistente

Conceitos

Projetando um assistente

Configurando arquivos .Vsz para iniciar assistentes

Outros recursos

Criando suplementos e assistentes