Пошаговое руководство. Создание первой надстройки VSTO для Outlook

В этом пошаговом руководстве показано, как создать надстройку VSTO для Microsoft Office Outlook. Функции, создаваемые в подобном решении, доступны для приложения независимо от того, какой элемент Outlook открыт. Дополнительные сведения см. в обзоре разработки решений Office (VSTO).

Область применения. Сведения в этом разделе относятся к проектам надстроек VSTO для Outlook. Дополнительные сведения см. в разделе "Функции", доступные по Приложение Office ликации и типу проекта.

Примечание.

Заинтересованы в разработке решений, которые расширяют возможности Office на нескольких платформах? Ознакомьтесь с новой моделью надстроек Office. Надстройки Office имеют небольшое пространство по сравнению с надстройками и решениями VSTO, и вы можете создавать их практически с помощью любой технологии веб-программирования, таких как HTML5, JavaScript, CSS3 и XML.

В этом пошаговом руководстве рассматриваются следующие задачи:

  • создание проекта надстройки VSTO для Outlook;

  • написание кода, использующего объектную модель Outlook для добавления текста в поле темы и текст нового электронного сообщения;

  • Построение и запуск проекта для тестирования.

  • Удаление завершенного проекта для прекращения автоматического запуска надстройки VSTO на компьютере разработчика.

    Примечание.

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

Необходимые компоненты

Для выполнения этого пошагового руководства требуются следующие компоненты:

Создание проекта

Создание проекта Outlook в Visual Studio

  1. Запустите среду Visual Studio.

  2. В меню Файл укажите Создать, затем нажмите Проект.

  3. В области шаблонов разверните узел Visual C# или Visual Basic, а затем узел Office/SharePoint.

  4. В развернутом узле Office/SharePoint выберите узел Надстройки Office .

  5. В списке шаблонов проектов выберите шаблон проекта надстройки VSTO Outlook.

  6. В поле Имя введите FirstOutlookAddIn.

  7. Щелкните OK.

    Visual Studio создает проект FirstOutlookAddIn и открывает файл кода ThisAddIn в редакторе.

Написание кода, добавляющего текст в каждое новое почтовое сообщение

Добавьте код в файл кода ThisAddIn. Новый код использует объектную модель Outlook для добавления текста к каждому новому почтовому сообщению. По умолчанию файл кода ThisAddIn содержит следующий созданный код:

  • Частичное определение класса ThisAddIn . Этот класс предоставляет точку входа для кода и обеспечивает доступ к объектной модели Outlook. Дополнительные сведения см. в разделе "Надстройки VSTO программы". Оставшаяся часть ThisAddIn класса определена в скрытом файле кода, который не следует изменять.

  • Обработчики событий ThisAddIn_Startup и ThisAddIn_Shutdown . Эти обработчики событий вызываются, когда Outlook загружает и выгружает надстройку VSTO. Их можно использовать для инициализации надстройки VSTO в процессе ее загрузки, а также для освобождения ресурсов, используемых вашей надстройкой VSTO при ее выгрузке. Дополнительные сведения см. в разделе "События" в проектах Office.

Добавление текста в поле темы и текст каждого нового электронного сообщения

  1. В файле кода ThisAddIn объявите поле с именем inspectors в классе ThisAddIn . Поле inspectors содержит ссылку на коллекцию окон инспектора в текущем экземпляре Outlook. Эта ссылка не позволит сборщику мусора освободить память, содержащую обработчик событий для NewInspector .

    Outlook.Inspectors inspectors;
    
  2. Замените метод ThisAddIn_Startup приведенным ниже кодом. Этот код присоединяет обработчик событий к NewInspector .

    private void ThisAddIn_Startup(object sender, System.EventArgs e)
    {
        inspectors = this.Application.Inspectors;
        inspectors.NewInspector +=
        new Microsoft.Office.Interop.Outlook.InspectorsEvents_NewInspectorEventHandler(Inspectors_NewInspector);
    }
    
  3. В файл кода ThisAddIn добавьте в класс ThisAddIn указанный ниже код. Он присоединяет обработчик событий к NewInspector .

    Когда пользователь создает сообщение, этот обработчик событий добавляет текст в строку темы и текст сообщения.

    void Inspectors_NewInspector(Microsoft.Office.Interop.Outlook.Inspector Inspector)
    {
        Outlook.MailItem mailItem = Inspector.CurrentItem as Outlook.MailItem;
        if (mailItem != null)
        {
            if (mailItem.EntryID == null)
            {
                mailItem.Subject = "This text was added by using code";
                mailItem.Body = "This text was added by using code";
            }
    
        }
    }
    

    Для изменения каждого нового сообщения в приведенных выше примерах кода используются следующие объекты.

  • Поле Application класса ThisAddIn . Поле Application возвращает объект Application , который представляет текущий экземпляр Outlook.

  • Параметр Inspector обработчика событий для события NewInspector . Параметр Inspector — это объект Inspector , представляющий окно инспектора нового почтового сообщения. Дополнительные сведения см. в разделе "Решения Outlook".

Тестирование проекта

При построении и запуске проекта убедитесь, что текст отображается в строке темы и тексте нового почтового сообщения.

Тестирование проекта

  1. Нажмите клавишу F5 для построения и запуска проекта.

    При построении проекта код компилируется в сборку, которая включается в выходную папку сборки для проекта. Visual Studio также создает ряд записей реестра, которые позволяют Outlook обнаружить и загрузить надстройку VSTO, и настраивает параметры безопасности на компьютере разработчика, разрешая запуск надстройки VSTO. Дополнительные сведения см. в обзоре процесса сборки решений Office.

  2. В Outlook создайте новое почтовое сообщение.

  3. Убедитесь, что следующий текст добавляется в строку темы и текст сообщения.

    Этот текст добавляется с помощью кода.

  4. Закрыть Outlook.

Очистка проекта

Завершив разработку проекта, удалите с компьютера сборку надстройки VSTO, записи реестра и параметры безопасности. В противном случае надстройка VSTO будет запускаться при каждом открытии Outlook на компьютере разработчика.

Очистка проекта

  1. В Visual Studio в меню Построение выберите пункт Очистить решение.

Следующие шаги

Теперь, когда вы создали базовую надстройку VSTO для Outlook, изучите более подробную информацию о разработке надстроек VSTO в следующих разделах.

  • Общие задачи программирования, которые можно выполнять с помощью надстроек VSTO для Outlook. Дополнительные сведения см. в разделе "Надстройки VSTO программы".

  • Использование объектной модели Outlook. Дополнительные сведения см. в разделе "Решения Outlook".

  • Настройка пользовательского интерфейса Outlook, например путем добавления настраиваемой вкладки на ленту или создания собственной настраиваемой области задач. Дополнительные сведения см. в разделе "Настройка пользовательского интерфейса Office".

  • Построение и отладка надстроек VSTO для Outlook. Дополнительные сведения см. в статье "Сборка решений Office".

  • Развертывание надстроек VSTO для Outlook. Дополнительные сведения см. в статье "Развертывание решения Office".