Записи реестра для надстроек VSTO

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

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

Замечание

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

При сборке проекта Visual Studio создает эти записи реестра на компьютере разработки. Это позволяет удобно запускать и отлаживать VSTO-надстройку. С помощью ClickOnce для развертывания надстройки VSTO записи реестра автоматически создаются на компьютере конечного пользователя.

Дополнительные сведения о развертывании решения VSTO с помощью установщика Windows см. в статье "Развертывание решения VSTO с помощью установщика Windows".

Дополнительные сведения о том, как записи реестра используются во время загрузки надстроек VSTO, см. в разделе "Архитектура надстроек VSTO".

Замечание

В этом разделе текст идентификатор надстройки представляет уникальный идентификатор надстройки VSTO. По умолчанию идентификатор — это имя данной сборки надстройки VSTO.

Регистрация надстроек VSTO для текущего пользователя и всех пользователей

При установке надстройки VSTO ее можно зарегистрировать двумя способами:

• Только для текущего пользователя (надстройка VSTO доступна только пользователю, вошедшего на компьютер при установке надстройки). В этом случае записи реестра создаются в HKEY_CURRENT_USER.

• Для всех пользователей (то есть любой пользователь, который входит на компьютер, может использовать надстройку VSTO). В этом случае записи реестра создаются в HKEY_LOCAL_MACHINE.

  Все надстройки VSTO, созданные с помощью Visual Studio, можно зарегистрировать для текущего пользователя. Однако надстройки VSTO могут быть зарегистрированы для всех пользователей только в определенных сценариях. Эти сценарии зависят от версии Microsoft Office на компьютере и способах развертывания надстройки VSTO.

Тип развертывания

Если вы используете ClickOnce для развертывания надстройки VSTO, надстройка VSTO может быть зарегистрирована только для текущего пользователя. Это связано с тем, что ClickOnce поддерживает только создание ключей в HKEY_CURRENT_USER. Если вы хотите зарегистрировать надстройку VSTO для всех пользователей на компьютере, необходимо использовать установщик Windows для развертывания надстройки VSTO. Дополнительные сведения об этих типах развертывания см. в статье "Развертывание решения Office с помощью ClickOnce и развертывание решения Office с помощью установщика Windows".

Записи реестра

Необходимые записи реестра для надстроек VSTO находятся в следующих ключах реестра, где корневой ключ — это HKEY_CURRENT_USER или HKEY_LOCAL_MACHINE в зависимости от того, производится ли установка для текущего пользователя или для всех пользователей.

Приложение Office	Путь к конфигурации
Visio	Root\Software\Microsoft\Visio\Addins\add-in ID
Все остальные	Root\Software\Microsoft\Office\Имя приложения Office\Addins\ID дополнения

Замечание

Если установщик предназначен для всех пользователей в 64-разрядной версии Windows, рекомендуется включить две записи реестра, одну из HKEY_LOCAL_MACHINE\Software\Microsoft и одну под HKEY_LOCAL_MACHINE\Software\WOW6432Node\Microsoft hive. Это связано с тем, что пользователи могут использовать 32-разрядные или 64-разрядные версии Office на компьютере.

Если установщик предназначен для текущего пользователя, он не должен устанавливаться в WOW6432Node, так как путь HKEY_CURRENT_USER\Software является общим.

Дополнительные сведения см. в разделе Данные приложений 32- и 64-разрядных версий в реестре.

В следующей таблице перечислены записи в этом ключе реестра.

Entry	Тип	Ценность
Описание	REG_SZ	Обязательное. Краткое описание надстройки VSTO. Это описание отображается, когда пользователь выбирает надстройку VSTO в области надстроек диалогового окна "Параметры " в приложении Microsoft Office.
FriendlyName	REG_SZ	Обязательное. Описательное имя надстройки VSTO, отображаемой в диалоговом окне надстроек COM в приложении Microsoft Office. Значением по умолчанию является идентификатор надстройки VSTO.
LoadBehavior	REG_DWORD	Обязательное. Значение, указывающее, когда приложение пытается загрузить надстройку VSTO и текущее состояние надстройки VSTO (загружено или выгрузлено). По умолчанию эта запись имеет значение 3, указывающее, что надстройка VSTO загружается при запуске. Дополнительные сведения см. в разделе "Значения LoadBehavior". Заметка: Если пользователь отключает надстройку VSTO, это действие изменяет значение LoadBehavior в кусте реестра HKEY_CURRENT_USER . Для каждого пользователя значение LoadBehavior в HKEY_CURRENT_USER hive переопределяет значение LoadBehavior по умолчанию, определенное в HKEY_LOCAL_MACHINE hive.
Манифест	REG_SZ	Обязательное. Полный путь манифеста развертывания для надстройки VSTO. Путь может быть расположением на локальном компьютере, сетевым общим ресурсом (UNC) или веб-сервером (HTTP). Если вы используете установщик Windows для развертывания решения, необходимо добавить префикс file:/// в путь манифеста . Кроме того, необходимо добавить строку |vstolocal (то есть символ | канала, за которым следует vstolocal) в конец этого пути. Это гарантирует загрузку вашего решения из папки установки, а не из кэша ClickOnce. Дополнительные сведения см. в статье "Развертывание решения Office с помощью установщика Windows". Заметка: При создании надстройки VSTO на компьютере разработки Visual Studio автоматически добавляет строку |vstolocal в эту запись реестра.

Записи реестра для областей форм Outlook

Если вы создаете пользовательский регион формы в надстройке VSTO для Outlook, для регистрации области формы в Outlook используются дополнительные записи реестра. Записи создаются в отдельном разделе реестра для каждого класса сообщений, поддерживаемого регионом формы. Эти разделы реестра находятся в следующем расположении, где корневой каталог HKEY_CURRENT_USER или HKEY_LOCAL_MACHINE.

Root\Software\Microsoft\Office\Outlook\FormRegions\класс сообщения

Как и другие записи реестра, которые совместно используются всеми надстройками VSTO, Visual Studio создает записи реестра для регионов формы на компьютере разработчика во время сборки проекта. С помощью ClickOnce для развертывания надстройки VSTO записи реестра автоматически создаются на компьютере конечного пользователя. При использовании установщика Windows для развертывания надстройки VSTO необходимо настроить проект InstallShield Limited Edition для создания записей реестра на компьютере конечного пользователя.

Дополнительные сведения о записях реестра регионов формы см. в разделе "Указание расположения области формы" в настраиваемой форме. Дополнительные сведения о регионах форм Outlook см. в статье "Создание областей форм Outlook".

Значения LoadBehavior

Запись LoadBehavior под ключом Root\Software\Microsoft\Office\application name\Addins\add-in ID содержит побитовое сочетание значений, определяющее поведение надстройки VSTO во время выполнения. Младший бит (значения 0 и 1) указывает, загружена или выгружена надстройка VSTO в настоящее время. Другие биты указывают, когда приложение пытается загрузить надстройку VSTO.

Как правило, запись LoadBehavior должна иметь значение 0, 3 или 16 (десятично), если надстройка VSTO установлена на компьютерах конечных пользователей. По умолчанию Visual Studio устанавливает для записи LoadBehavior дополнения VSTO значение 3 при сборке или публикации.

В следующей таблице перечислены все возможные значения записи LoadBehavior . Некоторые описания в этой таблице относятся к загрузке надстройки VSTO вручную или программно. Чтобы загрузить надстройку VSTO вручную, установите флажок рядом с надстройкой VSTO в диалоговом окне надстроек COM в приложении. Чтобы программно загрузить надстройку VSTO, задайте свойству объекта Connect, представляющего эту надстройку, значение COMAddIn.

Значение (в десятичном формате)	Состояние надстройки VSTO	Поведение загрузки надстройки VSTO	Description
0	Выгружен	Не загружайте автоматически	Приложение никогда не пытается загрузить надстройку VSTO автоматически. Пользователь может попытаться вручную загрузить надстройку VSTO или надстройку VSTO можно загрузить программным способом. Если надстройка VSTO успешно загружена, значение LoadBehavior остается 0, но состояние надстройки VSTO в диалоговом окне надстроек COM обновляется, чтобы указать, что надстройка VSTO загружается.
1	Нагруженный	Не загружайте автоматически	Приложение никогда не пытается загрузить надстройку VSTO автоматически. Пользователь может попытаться вручную загрузить надстройку VSTO или надстройку VSTO можно загрузить программным способом. Хотя диалоговое окно надстройки COM указывает, что надстройка VSTO загружается после запуска приложения, надстройка VSTO не загружается до тех пор, пока она не загружается вручную или программно. Если приложение успешно загружает надстройку VSTO, значение LoadBehavior изменяется на 0 и остается равным 0 после закрытия приложения.
2	Выгружен	Загрузка при запуске	Приложение не пытается автоматически загрузить надстройку VSTO. Пользователь может попытаться вручную загрузить надстройку VSTO или надстройку VSTO можно загрузить программным способом. Если приложение успешно загружает надстройку VSTO, значение LoadBehavior изменяется на 3 и остается в 3 после закрытия приложения.
3	Нагруженный	Загрузка при запуске	Приложение пытается загрузить надстройку VSTO при запуске приложения. Это значение по умолчанию при сборке или публикации надстройки VSTO в Visual Studio. Если приложение успешно загружает надстройку VSTO, значение LoadBehavior остается 3. Если при загрузке надстройки VSTO возникает ошибка, значение LoadBehavior изменяется на 2 и остается в 2 после закрытия приложения.
8	Выгружен	Загрузка по запросу	Приложение не пытается автоматически загрузить надстройку VSTO. Пользователь может попытаться вручную загрузить надстройку VSTO или надстройку VSTO можно загрузить программным способом. Если приложение успешно загружает надстройку VSTO, значение LoadBehavior изменится на 9.
9	Нагруженный	Загрузка по запросу	Надстройка VSTO загружается только в том случае, если приложение требует её. Например, когда пользователь выбирает элемент пользовательского интерфейса, использующий функциональные возможности надстройки VSTO (например, пользовательскую кнопку на ленте). Если приложение успешно загружает надстройку VSTO, значение LoadBehavior остается 9, но состояние надстройки VSTO в диалоговом окне надстроек COM обновляется, чтобы указать, что надстройка VSTO в настоящее время загружается. Если при загрузке надстройки VSTO возникает ошибка, значение LoadBehavior изменяется на 8.
16	Нагруженный	Загрузка в первый раз, а затем загрузка по запросу	Задайте это значение, если требуется, чтобы надстройка VSTO была загружена по запросу. Приложение загружает надстройку VSTO при первом запуске приложения. При следующем запуске приложения приложение загружает все элементы пользовательского интерфейса, определенные надстройкой VSTO. Однако надстройка VSTO не загружается, пока пользователь не выберет элемент пользовательского интерфейса, связанный с надстройкой VSTO. Когда приложение успешно загружает надстройку VSTO в первый раз, значение LoadBehavior остается 16 во время загрузки надстройки VSTO. После закрытия приложения значение LoadBehavior изменится на 9.

Связанный контент

• Архитектура решений Office в Visual Studio
• Архитектура расширений VSTO
• Создание решений Office
• Развертывание решения Office