Walkthrough: Criando um assistente

  • Artigo

Assistentes, como o o Assistente de suplemento, são programas que levam a um usuário por meio de uma série de ações para realizar uma tarefa difícil, complexa ou repetitiva. Windows, por exemplo, os assistentes usa para se conectar a recursos de rede, conectar-se a impressoras e assim por diante.

Em Visual Studio, os assistentes geralmente pedir uma série de perguntas que solicitam entrada de um usuário e, em seguida, usam os resultados para gerar código. Assistentes, no entanto, nem sempre exibem uma interface de usuário (UI). Eles podem ser programados para gerar o código nos bastidores de forma invisível.

Existem três tipos diferentes de assistentes.

  • Novos assistentes de projeto — como o nome sugere, esses assistentes são usados para gerar um novo código para um determinado tipo de projeto, oferecendo ao usuário um ponto de partida do qual deseja adicionar o seu próprio código. Este é o tipo mais comumente usado do assistente.

  • Adicionar Novo Item assistentes — esses assistentes são usados para adicionar novos itens, como, por exemplo, Web forms, arquivos de texto, HTML páginas, páginas XML e assim por diante, para um projeto.

  • Assistentes personalizados— esses assistentes não sejam chamados a partir de uma caixa de diálogo. Em vez disso, eles são chamados diretamente a partir de add-ins, macros ou outros tipos de código. Eles podem ou não podem exibir uma interface do usuário. Em ambos os casos, eles pode gerar código. Esse tipo de assistente é usado com freqüência menor.

Independentemente do tipo de assistente, todas elas têm características comuns.

  • Eles são.NET objetos que implementam o IDTWizard interface e tem um método associado, Execute, que contém o código que você deseja que o Assistente para executar.

  • Todos usam um arquivo vsz para exibir a mesmos na Visual Studio.

  • Eles todos geram código ou executam alguma tarefa.

Você pode personalizar a aparência de elementos de assistentes que você criar. Assistentes geralmente consistem em uma ou mais janelas ou páginas. Páginas podem conter uma imagem descritiva, como na parte superior ou para o lado esquerdo da página, uma descrição do rótulo, instruções e uma área na quais controles de navegação, como próximo e anterior podem ser colocados.

O processo de criação de assistentes no Visual C++ é um pouco diferente da criação de padrão Visual Studio assistentes. Para obter informações adicionais sobre a criação de assistentes, direcionados a Visual C++, consulte Projetar um assistente e Criando um assistente personalizado.

ObservaçãoObservação

As caixas de diálogo e comandos de menu demonstradas podem ser diferentes daqueles descritos na Ajuda, dependendo das configurações ativas ou configurações de edição. Esses procedimentos foram desenvolvidos com o General Development Settings ativo. Para alterar as configurações, escolha importação e Exportar configurações sobre o Ferramentas menu. Para obter mais informações, consulte Trabalhando com configurações.

Um exemplo de um assistente básico

Assistente de Suplemento do Visual Studio

Esta figura mostra um painel do O Assistente de suplemento, um tipo de novo projeto de assistente que orienta através de uma série de etapas para criar um suplemento. Você pode personalizar a aparência de seus assistentes, mas o O Assistente de suplemento é um bom exemplo do estilo de um tipo padrão do assistente. Concluído assistentes tornam-se modelos disponíveis no Novo projeto ou Add New Item caixas de diálogo.

A seguir demonstra como criar um assistente básico e, opcionalmente, dê a ele um ícone personalizado.

Para criar um assistente básico em Visual Basic e C# Visual

  1. Execute Visual Studio como um administrador. Registrar o assistente requer a atualização de registro, então ele precisa esse privilégio.

  2. Crie um novo projeto de biblioteca de classe denominado MyNewWizard.

  3. Adicionar referências a EnvDTE e EnvDTE80 para o projeto.

    Para fazer isso, clique com o botão direito do projeto e clique em Adicionar referência de. No.NET da Add Reference caixa de diálogo, clique EnvDTE e EnvDTE80 e OK.

No módulo de classe, incluem referências a EnvDTE e EnvDTE80 e implementar a IDTWizard interface. Para este Visual C# exemplo, você deve adicionar uma referência a System.Windows.Forms e System.Runtime.InteropServices.

Imports EnvDTE
Imports EnvDTE80
Public Class Class1
    Implements IDTWizard

using System;
using System.Collections.Generic;
using System.Text;
using EnvDTE;
using EnvDTE80;
using System. Windows.Forms;

using System.Runtime.InteropServices;

namespace MyNewWizard
{

[ComVisible(true)]

[Guid("20184B81-7C38-4E02-A1E3-8D564EEC2D25"),

ProgId("MyNewWizard.Class1")]

    public class Class1 : IDTWizard
    {
    }
}

Quando você adiciona o Implements instrução para Visual Basic, posicione o cursor no final da linha e pressione enter para criar automaticamente um Execute procedimento de método. Para Visual C#, no entanto, você deve adicionar o Execute procedimento manualmente:

public class Class1 : IDTWizard
    {
    public void Execute(object Application, 
        int hwndOwner, ref object[] contextParams, 
        ref object[] customParams, 
        ref EnvDTE.wizardResult retval)

  1. Adicione o código que você deseja que o Assistente para executar o Execute procedimento. Neste exemplo, adicionaremos apenas uma caixa de mensagem simples.

    Você deve ter o seguinte:

    Imports EnvDTE
Imports EnvDTE80

Public Class Class1
    Implements IDTWizard

    Public Sub Execute(ByVal Application As Object, ByVal _
    hwndOwner As Integer, ByRef ContextParams() As Object, ByRef _
    CustomParams() As Object, ByRef retval As EnvDTE.wizardResult) _
    Implements EnvDTE.IDTWizard.Execute
        MsgBox("The wizard is now running.")
    End Sub
End Class 

    using System.Text;
using EnvDTE;
using EnvDTE80;
using System.Windows.Forms;
using System.Runtime.InteropServices;

namespace MyNewWizardCS
{
    public class Class1 : IDTWizard
    {

    public void Execute(object Application, 
        int hwndOwner, ref object[] contextParams, 
        ref object[] customParams, 
        ref EnvDTE.wizardResult retval)
    {
        MessageBox.Show("The wizard is now running.");
    }
}

}

    O Execute procedimento é chamado quando o assistente for iniciado.

  2. Clique com o botão direito do projeto na Solution Explorer e clique em Propriedades para abrir o Propriedades do projeto página, clique no Build guia e, em seguida, verifique o Register for COM interop na parte inferior da página.

  3. No arquivo AssemblyInfo. cs, localize o ComVisible de atributo e defina-o como true.

  4. Construir o projeto para criar a dll da biblioteca de classe clicando Build Solution sobre o Build menu.

  5. Crie um arquivo de texto vsz para que o assistente chamado MyNewWizard.vsz.

    Para fazer isso, fazer uma cópia de um arquivo vsz existente, como qualquer um deles localizado em < Visual Studio Install Directory >\VC#\CSharpProjectItems\Windows de formulários e renomeie-a como "MyNewWizard.vsz".

    Um arquivo vsz é um arquivo de texto que permite que Visual Studio para reconhecer o assistente e exibi-la na Novo projeto ou Add New Item caixas de diálogo. O Wizard parâmetro deve ser definido como o progID (Project.Classname) do projeto ou a GUID. Para obter mais informações, consulte Configurando.Arquivos vsz iniciar assistentes.

    ObservaçãoObservação

    Opcionalmente, você também pode criar um arquivo de VSDir para o assistente. Contém informações que exibe como uma descrição para o assistente no Add Novo projeto ou Add Novo arquivo caixas de diálogo. Também permite que você especificar um ícone e organizar sua localização na lista. Para obter mais informações, consulte Adicionando os assistentes para o Item Adicionar e caixas de Diálogo Novo projeto usando.Arquivos de Vsdir.

  6. Substitua o conteúdo de MyNewWizard.vsz com o seguinte:

    VSWizard 7.0
Wizard=MyNewWizard.Class1
Param=First Item
Param=Second Item

  7. Salve o novo arquivo vsz no diretório onde você deseja que o assistente apareça.

    Neste exemplo, queremos que o assistente apareça na Add New Item caixa de diálogo de Visual Basic projetos, portanto, salve o arquivo vsz no seguinte diretório: < diretório de instalação do Visual Studio >\VB\VBProjectItems.

  8. Sair Visual Studio e reinicie o proprietário.

    Isso força Visual Studio para ler o novo arquivo vsz.

  9. Criar uma nova Visual Basic o projeto, tais como um projeto de aplicativo do Windows.

  10. Clique com o botão direito no projeto, aponte para Add iteme em seguida, clique em Novo Item.

    Você deve ver o Assistente de novo (MyNewWizard) na Adicionar novos itens caixa de diálogo.

  11. Clique no assistente e clique no Add botão.

    Você verá a mensagem, "O assistente está em execução."

Para exibir um ícone personalizado para o Assistente de novo

  • Coloque um arquivo de ícone com o mesmo nome de arquivo base do arquivo. dll, mas com uma extensão. ico no mesmo diretório do arquivo do assistente.

    Por exemplo, se o assistente é denominado MyNewWizard.dll, nomeie o arquivo. ico MyNewWizard.ico.

    - ou -

  • Se você tiver criado um arquivo de VSDir, especifique um caminho para o arquivo de ícone (. ico).

Consulte também

Tarefas

How to: Criar um Adicionar-

Referência

IDTWizard

Switches e comandos de Visual Studio

Conceitos

Automation Object Model Chart

Adicionando os assistentes para o Item Adicionar e caixas de Diálogo Novo projeto usando.Arquivos de Vsdir

Configurando.Arquivos vsz iniciar assistentes

Outros recursos

Criação de assistentes e ins Adicionar-