Практическое руководство. Обработка событий автоматизации (Visual C#)

Статья
02/20/2013

В следующей процедуре показано, как обрабатывать связанные с окнами события с помощью надстройки Visual C#.

Примечание
Отображаемые диалоговые окна и команды меню могут отличаться от описанных в справке в зависимости от текущих настроек или выпуска.Эти процедуры были разработаны с обычными параметрами разработки.Чтобы изменить параметры, в меню Сервис выберите команду Импорт и экспорт параметров.Дополнительные сведения см. в разделе Параметры Visual Studio.

Отображаемые диалоговые окна и команды меню могут отличаться от описанных в справке в зависимости от текущих настроек или выпуска.Эти процедуры были разработаны с обычными параметрами разработки.Чтобы изменить параметры, в меню Сервис выберите команду Импорт и экспорт параметров.Дополнительные сведения см. в разделе Параметры Visual Studio.

Для обработки событий, связанных с окнами, с помощью языка Visual C#

Создайте проект надстройки Visual Studio, используя Visual C#.
В методе OnConnection инициализируйте переменную для перехвата событий.В приведенном ниже примере переменная называется events.
```
EnvDTE.Events events = _applicationObject.Events;
```
В методе OnConnection извлеките объекты событий из модели автоматизации.
```
winEvents = (EnvDTE.WindowEvents)events.get_WindowEvents(null);
```
В этом примере переменная называется winEvents.Другие объекты в модели автоматизации относятся к другим типам событий.Например, FindEvents применяется к событиям, связанным с операциями поиска, а TaskListEvents применяется к событием, связанным со списком задач.Полный список доступных событий см. в разделе Реакция на события автоматизации.
В методе OnConnection подключитесь к каждому делегату объектов событий, полученных на шаге 3, используя оператор +=.Например, для подключения делегатов, полученных событием WindowClosing, можно использовать:
```
winEvents.WindowClosing += new  
_dispWindowEvents_WindowClosingEventHandler(this.WindowClosing);
```
Добавьте процедуры для каждого события, связанного с объектом событий.Например, для обработки события, возникающего при закрытии окна (WindowClosing), можно использовать следующее:
```
public void WindowClosing(EnvDTE.Window closingWindow)
{
    outputWindowPane.OutputString ("WindowEvents::WindowClosing\n");
    outputWindowPane.OutputString("\tWindow: " + 
    closingWindow.Caption + "\n");
}
```
При использовании объекта WindowEvents требуются процедуры для всех его событий, а именно:
И наконец, чтобы не допустить замедление системы средой Visual Studio вследствие постоянного отслеживания событий, связанных с окнами после закрытия надстройки, отключите обработку событий.В Visual C# для этого служит оператор -=.Например, для отключения обработки событий WindowClosing можно использовать:
```
public void OnDisconnection(ext_DisconnectMode disconnectMode, 
ref Array custom)
{
    if (winEvents != null)
    {
        winEvents.WindowClosing -= new 
        _dispWindowEvents_WindowClosingEventHandler     
        (this.WindowClosing);
    }
}
```
Это обеспечивает отключение обработчика событий при завершении работы надстройки или при завершении работы интегрированной среды разработки (даже если надстройка продолжает работать).При завершении работы интегрированной среды разработки все запущенные надстройки также выключаются.

Пример

В следующем примере показана простая надстройка Visual C#, которая демонстрирует перехват и обработку событий, связанных с окнами, в Visual Studio.При возникновении любого события, связанного с окнами, в окно Вывод отправляется уведомление.

namespace CSEventsAddin
{
    using System;
    using Microsoft.VisualStudio.CommandBars;
    using Extensibility;
    using EnvDTE;
    using EnvDTE80;

    public class Connect : Object, IDTExtensibility2
    {
        public Connect()
        {
        }

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

            // Retrieve the event objects from the automation model.
            EnvDTE.Events events = _applicationObject.Events;
            // Send event messages to the Output window.
            OutputWindow outputWindow = 
            (OutputWindow)_applicationObject.Windows.Item
            (Constants.vsWindowKindOutput).Object;
            outputWindowPane = outputWindow.OutputWindowPanes.Add("DTE 
Event Information");
            // Retrieve the event objects from the automation model.
            winEvents = 
            (EnvDTE.WindowEvents)events.get_WindowEvents(null);

            // Connect to each delegate exposed from each object 
            // retrieved above.
            winEvents.WindowActivated += new 
            _dispWindowEvents_WindowActivatedEventHandler
            (this.WindowActivated);
            winEvents.WindowClosing += new  
            _dispWindowEvents_WindowClosingEventHandler
            (this.WindowClosing);
            winEvents.WindowCreated += new  
            _dispWindowEvents_WindowCreatedEventHandler
            (this.WindowCreated);
            winEvents.WindowMoved += new 
            _dispWindowEvents_WindowMovedEventHandler
            (this.WindowMoved);
        }

        public void OnDisconnection(ext_DisconnectMode disconnectMode, 
        ref Array custom)
        {
            // If the delegate handlers have been connected, then 
            // disconnect them here. 
            // If this is not done, the handlers may still 
            // fire until the next garbage collection event.
            if (winEvents != null)
            {
                winEvents.WindowActivated -= new 
                _dispWindowEvents_WindowActivatedEventHandler
                (this.WindowActivated);
                winEvents.WindowClosing -= new 
                _dispWindowEvents_WindowClosingEventHandler
                (this.WindowClosing);
                winEvents.WindowCreated -= new 
                _dispWindowEvents_WindowCreatedEventHandler
                (this.WindowCreated);
                winEvents.WindowMoved -= new 
                _dispWindowEvents_WindowMovedEventHandler
                (this.WindowMoved);
            }
        }

        // Window-related events.
        public void WindowClosing(EnvDTE.Window closingWindow)
        {
            outputWindowPane.OutputString
("WindowEvents::WindowClosing\n");
            outputWindowPane.OutputString("\tWindow: " + 
closingWindow.Caption + "\n");
        }

        public void WindowActivated(EnvDTE.Window gotFocus,   
        EnvDTE.Window lostFocus)
        {
            outputWindowPane.OutputString
("WindowEvents::WindowActivated\n");
            outputWindowPane.OutputString("\tWindow receiving focus: " 
+ gotFocus.Caption + "\n");
            outputWindowPane.OutputString("\tWindow that lost focus: " 
+ lostFocus.Caption + "\n");
        }

        public void WindowCreated(EnvDTE.Window window)
        {
            outputWindowPane.OutputString
            ("WindowEvents::WindowCreated\n");
            outputWindowPane.OutputString("\tWindow: " + window.Caption 
+ "\n");
        }

        public void WindowMoved(EnvDTE.Window window, int top, int 
        left, int width, int height)
        {
            outputWindowPane.OutputString
            ("WindowEvents::WindowMoved\n");
            outputWindowPane.OutputString("\tWindow: " + window.Caption 
+ "\n");
            outputWindowPane.OutputString("\tLocation: (" + 
top.ToString() + " , " + left.ToString() + " , " + 
width.ToString() + " , " + height.ToString() + ")\n");
        }

        public void OnAddInsUpdate(ref Array custom)
        {
        }

        public void OnStartupComplete(ref Array custom)
        {
        }

        public void OnBeginShutdown(ref Array custom)
        {
        }

        private DTE2 _applicationObject;
        private AddIn _addInInstance;
        private EnvDTE.WindowEvents winEvents;
        private OutputWindowPane outputWindowPane;
    }
}

Компиляция кода

Для компиляции кода создайте новый проект надстройки Visual C# и замените код в классе Connect кодом из данного примера.

См. также

Поделиться через

Практическое руководство. Обработка событий автоматизации (Visual C#)

Для обработки событий, связанных с окнами, с помощью языка Visual C#

Пример

Компиляция кода

См. также

Задачи

Ссылки

Другие ресурсы

Дополнительные ресурсы