Записи реестра для надстроек уровня приложения

Статья
02/20/2013

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

Применение. Сведения этого раздела применяются к проектам уровня приложения для Microsoft Office 2013 Preview и Microsoft Office 2010. Дополнительные сведения см. в разделе Доступность функций по типам приложений Office и проектов.

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

Дополнительные сведения об использовании записей реестра в процессе загрузки надстроек см. в разделе Архитектура надстроек уровня приложения.

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

Регистрация надстройки для текущего пользователя ПРОТИВ. всех пользователей

Если надстройка установлена, существует два способа ее регистрации:

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

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

Версия Microsoft Office

Приложения Microsoft Office 2010 и Microsoft Office 2013 могут загружать надстройки, зарегистрированных в разделе HKEY_LOCAL_MACHINE или HKEY_CURRENT_USER.

Загрузка надстройки, зарегистрированных в разделе HKEY_LOCAL_MACHINE, компьютеры должны иметь установить пакет обновления 976477.Дополнительные сведения см. по адресу https://go.microsoft.com/fwlink/?LinkId=184923.

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

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

Разделы реестра

Запрашиваемые записи реестра надстройки размещаются в следующем разделе реестра для всех приложений, кроме Visio, где корень — это HKEY_CURRENT_USER или HKEY_LOCAL_MACHINE.

Root\Software\Microsoft\Office\имя_приложения\Addins\идентификатор_надстройки

Записи реестра для Visio расположены в следующем разделе реестра.

Root\Software\Microsoft\Visio\Addins\ИД_надстройки

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

Entry	Тип	Значение
Description	REG_SZ	Обязательное.Краткое описание надстройки. Описание, отображаемое при выборе пользователем надстройки в области Надстройки диалогового окна Параметры в приложении Microsoft Office.
FriendlyName	REG_SZ	Обязательное.Описательное имя надстройки, которое отображается в диалоговом окне Надстройки СOM в приложении Microsoft Office.Значением по умолчанию является идентификатор надстройки.
LoadBehavior	REG_DWORD	Обязательное.Значение, определяющее, когда приложение пытается загрузить надстройку, и текущее состояние надстройки (загружена или выгружена). По умолчанию данному параметру присвоено значение 3, которое означает, что надстройка загружается при запуске.Дополнительные сведения см. в разделе Значения LoadBehavior.
Manifest	REG_SZ	Обязательное.Полный путь манифеста развертывания надстройки.В качестве пути может быть указано расположение на локальном компьютере, сетевая папка (UNC) или веб-сервер (HTTP). При использовании установщика Windows для развертывания решения, необходимо добавить префикс file:/// в папке манифест.Необходимо также добавить строку \|vstolocal (то есть символ канала\|и после него vstolocal) в конце этого пути.Это гарантирует загрузку решения из папки установки, а не кэша ClickOnce.Дополнительные сведения см. в разделе Развертывание решения Office с помощью установщика Windows. Примечание При построении надстройки на компьютере разработчика Visual Studio автоматически прикрепляет строку \|vstolocal к этой записи реестра.
Warmup	REG_DWORD	Необязательный параметр.Значение, указывающее, что .NET Framework и Visual Studio Tools for Office (cреда выполнения) должны загружаться до загрузки надстройки, тем самым сокращая кажущееся время загрузки надстройки.Задайте для Warmup значение 1, и использовать его в сочетании с записью LoadBehavior для сокращения времени загрузки для Outlook 2010 и Outlook 2013 надстройки, развертывания с помощью установщика Windows (MSI).Этот раздел реестра невозможно настроить с использованием ClickOnce.

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

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

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

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

Дополнительные сведения о записях реестра областей форм см. в разделе Задание областей форм в реестре Windows.Дополнительные сведения об областях формы Outlook см. в разделе Создание областей форм Outlook.

Значения LoadedBehavior

Запись LoadBehavior в разделе реестра Root\Software\Microsoft\Office\имя_приложения\Addins\ИД_надстройки содержит побитовую комбинацию значений, указывающих поведение во время выполнения надстройки.Наименьший порядковый бит (значения 0 и 1) указывает, выгружена или загружена надстройка в текущий момент.Остальные биты указывают, когда приложение пытается загрузить надстройку.

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

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

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