Compartilhar via

Passo a passo: 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, se conectar às impressoras e assim por diante.

Na Visual Studio, assistentes geralmente pedir uma série de perguntas que solicitam entrada de um usuário e, em seguida, usar os resultados para gerar o 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 o 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 exibir uma interface do usuário.Em ambos os casos, eles geram código.Esse tipo de assistente é usado com freqüência, o 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 seja executado.

  • 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 nos 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 Exportarconfigurações sobre o Ferramentas menu.Para obter mais informações, consulte Configurações de Visual Studio.

Um exemplo de um assistente básico

Assistente de suplemento do Visual Studio

Esta figura mostra um painel da Assistente Add-In, um tipo de novo projeto de assistente que o conduz por uma série de etapas para criar um suplemento.Você pode personalizar a aparência de seus assistentes, mas o Assistente Add-In é 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, atribua a ele um ícone personalizado.

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

  1. Execute Visual Studio como um administrador.Registrar o assistente requer a atualização do 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 ao projeto.

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

No módulo de classe, incluir 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 o procedimento de método.Para Visual C#, Entretanto, 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 deve ser executado para o Execute procedimento.Neste exemplo, estamos apenas adicionar 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 o assistente chamado MyNewWizard.vsz.

    Para fazer isso, faça uma cópia de um arquivo vsz existente, como a nenhum daqueles localizado em < Visual Studio Install Directory >\VC#\CSharpProjectItems\Windows de formulários e renomeie-a "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 de vsz para iniciar assistentes.

    ObservaçãoObservação

    Opcionalmente, você também pode criar um arquivo de VSDir para o assistente.Contém informações que é exibido como uma descrição para o assistente no AddNovo projeto ou AddNovo arquivo caixas de diálogo.Ele também permite que você especifique um ícone e organizar sua localização na lista.Para obter mais informações, consulte A adição de assistentes para a adicionar o Item 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: < Visual Studio Install Directory >\VB\VBProjectItems.

  8. Sair Visual Studio e, em seguida, reiniciá-lo.

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

  9. Criar uma nova Visual Basic o projeto, como, por exemplo, um projeto Windows Application.

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

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

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

    Você verá a mensagem, "O assistente agora está executando".

Para exibir um ícone personalizado para o novo Assistente

  • Coloque um arquivo de ícone com o mesmo nome de arquivo de base que o arquivo. dll, mas com uma extensão. ico no mesmo diretório que o 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) lá.

Consulte também

Tarefas

Como: criar um suplemento

Referência

IDTWizard

Switches e comandos de Visual Studio

Conceitos

Gráfico de modelo de objeto de automação

A adição de assistentes para a adicionar o Item e caixas de diálogo Novo projeto usando.Arquivos de Vsdir

Configurando.Arquivos de vsz para iniciar assistentes

Outros recursos

A criação de suplementos e assistentes