Como: responder a eventos em um projeto específico (Visual C#)

Artigo
02/25/2013

O modelo de automação inclui objetos que podem ser usados para responder a eventos de ambiente na Visual Studio o ambiente de desenvolvimento integrado (IDE).Os eventos de ambiente definidos na VSLangProj e VSLangProj80 são específicas para Visual C# e Visual Basic projetos.Por exemplo, ImportsEvents é disparado quando uma importação for adicionada ou removida de um Visual Basic project.

Este exemplo usa Visual C# para adicionar uma ReferencesEvents o manipulador de eventos, que é específico para um tipo de projeto, para um projeto do suplemento.ReferencesEventssão gerados quando uma referência é alterada, adicionada ou removida um Visual C# ou Visual Basic project.

Observaçã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 Import and Export Settings sobre o Ferramentas menu.Para obter mais informações, consulte Configurações de Visual Studio.

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 Import and Export Settings sobre o Ferramentas menu.Para obter mais informações, consulte Configurações de Visual Studio.

Para lidar com a referência de eventos relacionados usando o Visual C#

Criar um Visual Studio projeto de suplemento no Visual C#.
Adicionar using VSLangProj; na parte superior do arquivo Connect. cs.
Sobre o projeto menu, clique em Add Reference, clique no .NET , selecione o primeiro VSLangProj e clique em OK.
Na classe Connect, inicializar uma variável para lidar com o ReferencesEvents objeto e outro para lidar com um OutputWindowPane.
```
    private DTE2 _applicationObject;
    private AddIn _addInInstance;
    private VSLangProj.ReferencesEvents refEvents;
    private OutputWindowPane outputWinPane;
```
Neste exemplo, a variável é chamada refEvents.

Outros objetos no modelo de automação referem-se a outros tipos de eventos que são específicos para o projeto.Por exemplo, ImportsEvents é disparado quando uma importação é adicionada ou removida de um Imports coleção.BuildManagerEventsaplica-se para eventos relacionados a assemblies temporários criados a partir de saídas de ferramentas personalizadas.Para obter mais informações sobre BuildManager de objeto, consulte Introdução ao objeto BuildManager.Para obter uma lista completa dos eventos que são específicos para tipos de projetos, consulte Objetos de evento (específicas para tipos de projetos)e para obter uma lista dos eventos de automação gerais, consulte Objetos de evento de automação.
No OnConnection método, inicializar uma variável para interceptar eventos.Neste exemplo, a variável é chamada de events.
```
EnvDTE80.Events2 events = 
(EnvDTE80.Events2)_applicationObject.Events;
```

No OnConnection método, inicializar um OutputWindow variável.

OutputWindow outputWindow = (OutputWindow)_applicationObject.Windows.Item
(Constants.vsWindowKindOutput).Object;
outputWinPane = outputWindow.OutputWindowPanes.Add
("ReferencesEvents Event Information");

Também na OnConnection método, recuperar os objetos de evento do modelo de automação.
```
refEvents = 
(VSLangProj.ReferencesEvents)events.GetObject
("CSharpReferencesEvents");
```
Neste exemplo o ReferencesEvents são específicas para Visual C# projetos.Para responder a Visual Basic eventos específicos, substitua a seqüência, CSharpReferencesEvents, com VBReferencesEvents.Para obter mais informações sobre como determinar as cadeias de caracteres a ser usado para eventos que são específicos para diferentes tipos de projetos, consulte Objetos de evento (específicas para tipos de projetos).
Conectar-se a cada delegado exposto em objetos de evento do recuperada na etapa 3 usando o operador + =.Por exemplo conectar os delegados expostos pelo ReferenceAdded evento, você usaria:
```
refEvents.ReferenceAdded += new 
_dispReferencesEvents_ReferenceAddedEventHandler
(this.ReferenceAdded);
```
Adicione os procedimentos para cada evento que está relacionado ao objeto de evento.Por exemplo, para manipular o evento que ocorre quando uma referência é adicionada, você usaria:
```
public void ReferenceAdded( VSLangProj.Reference addedRef ) 
{ 
    outputWinPane.OutputString( "ReferencesEvents.ReferenceAdded" 
+ "\n" ); 
    outputWinPane.OutputString( "The reference to " + addedRef.Name
 + " was added." + "\n" ); 
}
```
No caso de ReferencesEvents, você deve ter os eventos definidos para:
- ReferenceAdded
- ReferenceRemoved
e
- ReferenceChanged.
A listagem completa do exemplo a seguir inclui esses eventos.
Por fim, para evitar Visual Studio da redução do seu sistema continuando a monitorar eventos relacionados a janela depois de fechar o add-in, você deve desabilitar a manipulação de eventos.Na Visual C# isso é feito usando o operador-=.Por exemplo, para desativar a manipulação de eventos para o ReferenceAdded você usaria:
```
refEvents.ReferenceAdded -= new
 _dispReferencesEvents_ReferenceAddedEventHandler
(this.ReferenceAdded);
```
Isso desativa a manipulação de eventos se o suplemento ou o IDE for desligado enquanto o add-in ainda está em execução.Quando o IDE for desligado, o todos os suplementos em execução são desligados automaticamente primeiro.

Exemplo

O exemplo a seguir é um basic Visual Studio suplemento que demonstra como interceptar e manipular Visual C# os eventos de referência Visual Studio.Sempre que ocorre um evento de referência, uma mensagem de notificação é enviada para o saída janela.

using System;
using Microsoft.VisualStudio.CommandBars;
using Extensibility;
using EnvDTE;
using EnvDTE80;
using VSLangProj;

public Connect()
  {
  }
  public void OnConnection(object application, Extensibility.ext_ConnectMode connectMode, object addInInst, ref System.Array custom)
  {
    _applicationObject = (DTE2)application;
    _addInInstance = (AddIn)addInInst;

    // Retrieve the event objects from the automation model.
    EnvDTE80.Events2 events = 
(EnvDTE80.Events2)_applicationObject.Events;
    // Send event messages to the Output window.
    OutputWindow outputWindow =
 (OutputWindow)_applicationObject.Windows.Item
(Constants.vsWindowKindOutput).Object;
    outputWinPane = 
outputWindow.OutputWindowPanes.Add
("ReferencesEvents Event Information");

    // Retrieve the event objects from the automation model.
    refEvents = (VSLangProj.ReferencesEvents)
events.GetObject("CSharpReferencesEvents");

    // Connect to each delegate exposed from each object 
    // retrieved above.
    refEvents.ReferenceAdded += new
 _dispReferencesEvents_ReferenceAddedEventHandler
(this.ReferenceAdded);
    refEvents.ReferenceChanged += new
 _dispReferencesEvents_ReferenceChangedEventHandler
(this.ReferenceChanged);
    refEvents.ReferenceRemoved += new
 _dispReferencesEvents_ReferenceRemovedEventHandler
(this.ReferenceRemoved); 
  }

  public void OnDisconnection(Extensibility.ext_DisconnectMode
 disconnectMode, ref System.Array custom)
  {
    // If the delegate handlers have been connected, then 
    // disconnect them here. 
    // If you do not do this, the handlers may still 
    // fire because they have not been garbage collected.
    if (refEvents != null)
    {
        refEvents.ReferenceAdded -= new
 _dispReferencesEvents_ReferenceAddedEventHandler
(this.ReferenceAdded);
        refEvents.ReferenceChanged -= new
 _dispReferencesEvents_ReferenceChangedEventHandler
(this.ReferenceChanged);
        refEvents.ReferenceRemoved -= new
 _dispReferencesEvents_ReferenceRemovedEventHandler
(this.ReferenceRemoved); 
    }
  }

  // References related events.
  public void ReferenceRemoved( VSLangProj.Reference removedRef ) 
  { 
    outputWinPane.OutputString( "ReferencesEvents.ReferenceRemoved"
 + "\n" ); 
    outputWinPane.OutputString( "The reference to " + removedRef.Name
 + " was removed." + "\n" ); 
  } 

  public void ReferenceChanged( VSLangProj.Reference changedRef ) 
  { 
    outputWinPane.OutputString( "ReferencesEvents.ReferenceChanged" 
+ "\n" ); 
    outputWinPane.OutputString( "The reference to " + changedRef.Name 
+ " was changed." + "\n" ); 
  } 
        
  public void ReferenceAdded( VSLangProj.Reference addedRef ) 
  { 
    outputWinPane.OutputString( "ReferencesEvents.ReferenceAdded" +
 "\n" ); 
    outputWinPane.OutputString( "The reference to " + addedRef.Name 
+ " was added." + "\n" ); 
  } 
  public void OnAddInsUpdate(ref System.Array custom)
  {
  }
  public void OnStartupComplete(ref System.Array custom)
  {
  }
  public void OnBeginShutdown(ref System.Array custom)
  {
  }
  private DTE2 _applicationObject;
  private AddIn _addInInstance;
  private VSLangProj.ReferencesEvents refEvents;
  private OutputWindowPane outputWinPane;
  }}

Compilando o código

Para compilar esse código, crie um novo Visual Studio projeto de suplemento no Visual C# e substitua o código da classe conectar-se com o código do exemplo.Para obter informações sobre como executar um suplemento, consulte Como: Add-Ins de controle, usando o Gerenciador de suplemento.

Consulte também

Compartilhar via

Como: responder a eventos em um projeto específico (Visual C#)

Para lidar com a referência de eventos relacionados usando o Visual C#

Exemplo

Compilando o código

Consulte também

Tarefas

Referência

Outros recursos

Recursos adicionais