Записи реестра для надстроек VSTORegistry entries for VSTO Add-ins

При развертывании надстроек VSTO, созданных с помощью Visual Studio, необходимо создать определенный набор записей реестра.You must create a specific set of registry entries when you deploy VSTO Add-ins that are created by using Visual Studio. Эти записи реестра предоставляют сведения, позволяющие приложению Microsoft Office обнаружить и загрузить надстройку VSTO.These registry entries provide information that enables the Microsoft Office application to discover and load the VSTO Add-in.

Область применения: Сведения этого раздела применяются к VSTO добавьте-в проектах.Applies to: The information in this topic applies to VSTO Add-in projects. Дополнительные сведения см. в разделе функций по типам приложений и проектов Office.For more information, see Features available by Office application and project type.

Note

Интересуетесь разработкой решений, расширяющих возможности Office на нескольких платформах?Interested in developing solutions that extend the Office experience across multiple platforms? Ознакомьтесь с новой моделью надстроек Office.Check out the new Office Add-ins model. Надстройки Office имеют небольшой объем по сравнению с надстройками и решениями VSTO, и их можно создавать с помощью практически любой технологии веб-программирования, такой как HTML5, JavaScript, CSS3 и XML.Office Add-ins have a small footprint compared to VSTO Add-ins and solutions, and you can build them by using almost any web programming technology, such as HTML5, JavaScript, CSS3, and XML.

При выполнении сборки проекта Visual Studio создает эти записи реестра на компьютере разработчика, упрощая запуск и отладку надстройки VSTO.When you build your project, Visual Studio creates these registry entries on the development computer so that you can easily run and debug the VSTO Add-in. Если вы используете ClickOnce для развертывания надстройки VSTO, записи реестра автоматически создаются на компьютере конечного пользователя.If you use ClickOnce to deploy your VSTO Add-in, the registry entries are automatically created on the end-user computer. При использовании установщик Windows для развертывания надстройки VSTO необходимо настроить проект InstallShield Limited Edition для создания записей реестра на компьютере конечного пользователя.If you use Windows Installer to deploy your VSTO Add-in, you must configure the InstallShield Limited Edition project to create the registry entries on the end-user computer.

Дополнительные сведения об использовании записей реестра для надстроек VSTO во время процесса загрузки см. в разделе Architecture of VSTO Add-ins.For more information about how the registry entries are used during the load process for VSTO Add-ins, see Architecture of VSTO Add-ins.

Note

В этом разделе текстовый идентификатор надстройки представляет собой уникальный идентификатор надстройки VSTO.In this topic, the text add-in ID represents a unique ID for your VSTO Add-in. По умолчанию идентификатором является имя сборки надстройки VSTO.By default, the ID is the name of your VSTO Add-in assembly.

Регистрация надстроек VSTO для текущего пользователя и всех пользователейRegister VSTO Add-ins for the current user vs. all users

После установки надстройку VSTO можно зарегистрировать одним из двух способов.When a VSTO Add-in is installed, it can be registered in two ways:

  • Только для текущего пользователя (т. е. он доступен только пользователю, который вошел в систему на компьютере при установке надстройки VSTO).For the current user only (that is, it is available only to the user that is logged on to the computer when the VSTO Add-in is installed). В этом случае записи реестра создаются в разделе HKEY_CURRENT_USER.In this case, the registry entries are created under the HKEY_CURRENT_USER.

  • Для всех пользователей (то есть любой пользователь, входящий в систему на компьютере, может использовать надстройку VSTO).For all users (that is, any user that logs on to the computer can use the VSTO Add-in). В этом случае записи реестра создаются в разделе HKEY_LOCAL_MACHINE.In this case, the registry entries are created under HKEY_LOCAL_MACHINE.

    Все надстройки VSTO, созданные с помощью Visual Studio, могут быть зарегистрированы для текущего пользователя.All VSTO Add-ins that you create by using Visual Studio can be registered for the current user. Однако для всех пользователей надстройки VSTO можно зарегистрировать только в определенных сценариях.However, VSTO Add-ins can be registered for all users only in certain scenarios. Эти сценарии зависят от версии Microsoft Office на компьютере и способа развертывания надстройки VSTO.These scenarios depend on the version of Microsoft Office on the computer and how the VSTO Add-in was deployed.

Версия Microsoft OfficeMicrosoft Office version

Приложения Office могут загружать надстройки VSTO, зарегистрированные в HKEY_LOCAL_MACHINE или HKEY_CURRENT_USER.Office applications can load VSTO Add-ins that are registered under HKEY_LOCAL_MACHINE or HKEY_CURRENT_USER.

Чтобы загрузить надстройки VSTO, зарегистрированные в разделе HKEY_LOCAL_MACHINE, на компьютерах должен быть установлен пакет обновления 976477.To load VSTO Add-ins that are registered under HKEY_LOCAL_MACHINE, computers must have update package 976477 installed. Дополнительные сведения см. на веб-сайте http://go.microsoft.com/fwlink/?LinkId=184923.For more information, see http://go.microsoft.com/fwlink/?LinkId=184923.

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

Надстройки VSTO, развернутые с использованием ClickOnce, можно зарегистрировать только для текущего пользователя.If you use ClickOnce to deploy a VSTO Add-in, the VSTO Add-in can be registered only for the current user. Это связано с тем, что ClickOnce поддерживает создание ключей только в HKEY_CURRENT_USER.This is because ClickOnce only supports creating keys under HKEY_CURRENT_USER. Если вы хотите зарегистрировать надстройку VSTO для всех пользователей компьютера, разверните ее с использованием установщика Windows.If you want to register a VSTO Add-in to all users on a computer, you must use Windows Installer to deploy the VSTO Add-in. Дополнительные сведения об этих типах развертывания см. в статье развертывание решения Office с помощью ClickOnce и развертывание решения office с помощью установщик Windows.For more information about these deployment types, see Deploy an Office solution by using ClickOnce and Deploy an Office solution by using Windows Installer.

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

Необходимые записи реестра надстроек VSTO находятся в следующем разделе реестра для всех приложений, кроме Visio, где rootHKEY_CURRENT_USER или HKEY_LOCAL_MACHINE.The required VSTO Add-in registry entries are located under the following registry key for all applications except Visio, where Root is HKEY_CURRENT_USER or HKEY_LOCAL_MACHINE.

Все приложения, за исключением VisioAll applications except for Visio

Версия OfficeOffice version Путь конфигурацииConfiguration Path
32-разрядная версия32-bit Имя корневого\приложения\софтваре\микрософт\оффице\идентификатор надстройки \аддинсRoot\Software\Microsoft\Office\application name\Addins\add-in ID
64-разрядная версия64-bit Имя корневого\приложения\Software\Wow6432Node\Microsoft\Office\идентификатор надстройки \аддинсRoot\Software\Wow6432Node\Microsoft\Office\application name\Addins\add-in ID

VisioVisio

Версия OfficeOffice version Путь конфигурацииConfiguration Path
32-разрядная версия32-bit Идентификатор надстройки root\софтваре\микрософт\висио\аддинс\Root\Software\Microsoft\Visio\Addins\add-in ID
64-разрядная версия64-bit Идентификатор надстройки root\Software\Wow6432Node\Visio\Addins\Root\Software\Wow6432Node\Visio\Addins\add-in ID

В следующей таблице перечислены записи в данном разделе реестра.The following table lists the entries under this registry key.

ВводEntry ТипType ЗначениеValue
ОписаниеDescription REG_SZREG_SZ Обязательный.Required. Краткое описание надстройки VSTO.A brief description of the VSTO Add-in.

Это описание отображается, когда пользователь выбирает надстройку VSTO на панели Надстройки диалогового окна Параметры в приложении Microsoft Office.This description is displayed when the user selects the VSTO Add-in in the Add-Ins pane of the Options dialog box in the Microsoft Office application.
FriendlyNameFriendlyName REG_SZREG_SZ Обязательный.Required. Описательное имя надстройки VSTO, которое отображается в диалоговом окне Надстройки COM в приложении Microsoft Office.A descriptive name of the VSTO Add-in that is displayed in the COM Add-Ins dialog box in the Microsoft Office application. Значением по умолчанию является идентификатор надстройки VSTO.The default value is the VSTO Add-in ID.
LoadBehaviorLoadBehavior REG_DWORDREG_DWORD Обязательный.Required. Значение, указывающее, когда приложение пытается загрузить надстройку VSTO и текущее состояние надстройки VSTO («Загружена» или «Выгружена»).A value that specifies when the application attempts to load the VSTO Add-in and the current state of the VSTO Add-in (loaded or unloaded).

По умолчанию эта запись имеет значение 3, которое означает, что надстройка VSTO загружается при запуске.By default, this entry is set to 3, which specifies that the VSTO Add-in is loaded at startup. Дополнительные сведения см. в разделе значения LoadBehavior.For more information, see LoadBehavior values. Примечание. Если пользователь отключает надстройку VSTO, это действие изменяет значение LoadBehavior в кусте реестра HKEY_CURRENT_USER .Note: If a user disables the VSTO Add-in, that action modifies LoadBehavior value in the HKEY_CURRENT_USER registry hive. Для каждого пользователя значение LoadBehavior в КУСТе HKEY_CURRENT_USER переопределяет значение LoadBehavior по умолчанию, определенное в кусте HKEY_LOCAL_MACHINE .For each user, the value of the LoadBehavior value in the HKEY_CURRENT_USER hive overrides the default LoadBehavior defined in the HKEY_LOCAL_MACHINE hive.
ManifestManifest REG_SZREG_SZ Обязательный.Required. Полный путь манифеста развертывания для надстройки VSTO.The full path of the deployment manifest for the VSTO Add-in. Путь может быть расположением на локальном компьютере, в сетевой папке (UNC) или на веб-сервере (HTTP).The path can be a location on the local computer, a network share (UNC), or a Web server (HTTP).

Если для развертывания решения используется установщик Windows, необходимо добавить префикс file:/// в путь манифеста .If you use Windows Installer to deploy the solution, you must add the prefix file:/// to the manifest path. В конце этого пути также необходимо добавить строку |vstolocal (то есть символ | вертикальной черты и значение vstolocal).You must also append the string |vstolocal (that is, the pipe character | followed by vstolocal) to the end of this path. Это гарантирует загрузку решения из папки установки, а не из кэша ClickOnce.This ensures that your solution is loaded from the installation folder, rather than the ClickOnce cache. Дополнительные сведения см. в статье развертывание решения Office с помощью установщик Windows.For more information, see Deploy an Office solution by using Windows Installer. Примечание. При создании надстройки VSTO на компьютере разработчика Visual Studio автоматически добавляет строку |vstolocal в эту запись реестра.Note: When you build a VSTO Add-in on the development computer, Visual Studio automatically appends the |vstolocal string to this registry entry.

Записи реестра для областей формы OutlookRegistry entries for Outlook form regions

При создании настраиваемой области формы в надстройке VSTO для приложения Outlook для регистрации области формы в Outlook используются дополнительные записи реестра.If you create a custom form region in a VSTO Add-in for Outlook, additional registry entries are used to register the form region with Outlook. Эти записи создаются в отдельном разделе реестра для каждого класса сообщений, поддерживаемого областью формы.These entries are created under a different registry key for each message class that the form region supports. Эти разделы реестра находятся в следующем расположении, где rootHKEY_CURRENT_USER или HKEY_LOCAL_MACHINE.These registry keys are in the following location, where Root is HKEY_CURRENT_USER or HKEY_LOCAL_MACHINE.

Класс сообщений root\софтваре\микрософт\оффице\аутлук\формрегионс\Root\Software\Microsoft\Office\Outlook\FormRegions\message class

Подобно другим записям реестра, общим для всех надстроек VSTO, Visual Studio создает записи реестра области формы на компьютере разработчика при выполнении сборки проекта.Like the other registry entries shared by all VSTO Add-ins, Visual Studio creates the form region registry entries on the development computer when you build your project. Если вы используете ClickOnce для развертывания надстройки VSTO, записи реестра автоматически создаются на компьютере конечного пользователя.If you use ClickOnce to deploy your VSTO Add-in, the registry entries are automatically created on the end-user computer. При использовании установщик Windows для развертывания надстройки VSTO необходимо настроить проект InstallShield Limited Edition для создания записей реестра на компьютере конечного пользователя.If you use Windows Installer to deploy your VSTO Add-in, you must configure the InstallShield Limited Edition project to create the registry entries on the end-user computer.

Дополнительные сведения о записях реестра области формы см. в разделе Указание расположения области формы в пользовательской форме.For more information about the form region registry entries, see Specify the location of a form region in a custom form. Дополнительные сведения о регионах форм Outlook см. в разделе Создание областей формы Outlook.For more information about Outlook form regions, see Create Outlook form regions.

Значения LoadBehaviorLoadBehavior values

Запись LoadBehavior в корневом\софтваре\микрософт\оффиценом\имени приложения\аддинс\ключидентификатора надстройки содержит побитовое сочетание значений, определяющих поведение времени выполнения Надстройка VSTO.The LoadBehavior entry under the Root\Software\Microsoft\Office\application name\Addins\add-in ID key contains a bitwise combination of values that specify the run time behavior of the VSTO Add-in. Младший бит (значения 0 и 1) указывает, загружена ли надстройка VSTO в данный момент.The lowest order bit (values 0 and 1) indicates whether the VSTO Add-in is currently unloaded or loaded. Остальные биты указывают, когда приложение пытается загрузить надстройку VSTO.Other bits indicate when the application attempts to load the VSTO Add-in.

Как правило, запись LoadBehavior должна иметь значение 0, 3 или 16 (в десятичном формате) при установке надстройки VSTO на компьютерах конечных пользователей.Typically, the LoadBehavior entry is intended to be set to 0, 3, or 16 (in decimal) when the VSTO Add-in is installed on end-user computers. По умолчанию при сборке или публикации надстройки VSTO Visual Studio устанавливает для записи LoadBehavior значение 3.By default, Visual Studio sets the LoadBehavior entry of your VSTO Add-in to 3 when you build or publish it.

В следующей таблице перечислены все возможные значения записи LoadBehavior .The following table lists all the possible values of the LoadBehavior entry. Некоторые описания в этой таблице относятся к загрузке надстройки VSTO вручную или программным путем.Some descriptions in this table refer to loading a VSTO Add-in manually or programmatically. Чтобы загрузить надстройку VSTO вручную, установите флажок рядом с надстройкой VSTO в диалоговом окне Надстройки COM в приложении.To load a VSTO Add-in manually, select the check box next to the VSTO Add-in in the COM Add-Ins dialog box in the application. Для загрузки надстройки VSTO программным способом укажите для свойства Connect объекта COMAddIn , представляющего надстройку VSTO, значение true.To load a VSTO Add-in programmatically, set the Connect property of the COMAddIn object that represents the VSTO Add-in to true.

Значение (десятичное)Value (in decimal) Состояние надстройки VSTOVSTO Add-in status Поведение при загрузке надстройки VSTOVSTO Add-in load behavior ОписаниеDescription
00 ВыгруженUnloaded Не загружать автоматическиDo not load automatically Приложение никогда не пытается загрузить надстройку VSTO автоматически.The application never tries to load the VSTO Add-in automatically. Пользователь может попытаться загрузить надстройку VSTO вручную или сделать это программными средствами.The user can try to manually load the VSTO Add-in, or the VSTO Add-in can be loaded programmatically.

Если настройка VSTO успешно загружена, значение LoadBehavior остается равным 0, но состояние надстройки VSTO в диалоговом окне Надстройки COM обновляется, указывая, что надстройка VSTO загружена.If the VSTO Add-in is successfully loaded, the LoadBehavior value remains 0, but the status of the VSTO Add-in in the COM Add-ins dialog box is updated to indicate that the VSTO Add-in is loaded.
11 ЗагруженLoaded Не загружать автоматическиDo not load automatically Приложение никогда не пытается загрузить надстройку VSTO автоматически.The application never tries to load the VSTO Add-in automatically. Пользователь может попытаться загрузить надстройку VSTO вручную или сделать это программными средствами.The user can try to manually load the VSTO Add-in, or the VSTO Add-in can be loaded programmatically.

Несмотря на то что диалоговое окно надстройки COM указывает на то, что НАДСТРОЙКа VSTO загружается после запуска приложения, Надстройка VSTO не загружается до тех пор, пока она не будет загружена вручную или программным способом.Although the COM Add-ins dialog box indicates that the VSTO Add-in is loaded after the application starts, the VSTO Add-in isn't loaded until it is loaded manually or programmatically.

Если приложение успешно загружает надстройку VSTO, значение LoadBehavior меняется на 0 и остается таким после закрытия приложения.If the application successfully loads the VSTO Add-in, the LoadBehavior value changes to 0, and remains at 0 after the application closes.
22 ВыгруженUnloaded Загружать при запускеLoad at startup Приложение не пытается загрузить надстройку VSTO автоматически.The application does not try to load the VSTO Add-in automatically. Пользователь может попытаться загрузить надстройку VSTO вручную или сделать это программными средствами.The user can try to manually load the VSTO Add-in, or the VSTO Add-in can be loaded programmatically.

Если приложение успешно загружает надстройку VSTO, значение LoadBehavior меняется на 3 и остается таким после закрытия приложения.If the application successfully loads the VSTO Add-in, the LoadBehavior value changes to 3, and remains at 3 after the application closes.
33 ЗагруженLoaded Загружать при запускеLoad at startup Приложение пытается загрузить надстройку VSTO при запуске приложения.The application tries to load the VSTO Add-in when the application starts. Это значение используется по умолчанию при выполнении сборки или публикации надстройки в Visual Studio.This is the default value when you build or publish a VSTO Add-in in Visual Studio.

Если приложение успешно загружает надстройку VSTO, значение LoadBehavior остается равным 3.If the application successfully loads the VSTO Add-in, the LoadBehavior value remains 3. Если при загрузке надстройки VSTO возникает ошибка, значение LoadBehavior меняется на 2 и остается таким после закрытия приложения.If an error occurs when loading the VSTO Add-in, the LoadBehavior value changes to 2, and remains at 2 after the application closes.
88 ВыгруженUnloaded Загружать по запросуLoad on demand Приложение не пытается загрузить надстройку VSTO автоматически.The application does not try to load the VSTO Add-in automatically. Пользователь может попытаться загрузить надстройку VSTO вручную или сделать это программными средствами.The user can try to manually load the VSTO Add-in, or the VSTO Add-in can be loaded programmatically.

Если приложение успешно загружает надстройку VSTO, значение LoadBehavior меняется на 9.If the application successfully loads the VSTO Add-in, the LoadBehavior value changes to 9.
99 ЗагруженLoaded Загружать по запросуLoad on demand Надстройка VSTO будет загружаться только в том случае, если она требуется приложению, например, если пользователь щелкнет элемент пользовательского интерфейса, использующий функциональность этой надстройки VSTO (например, настраиваемую кнопку на ленте).The VSTO Add-in will be loaded only when the application requires it, such as when a user clicks a UI element that uses functionality in the VSTO Add-in (for example, a custom button in the Ribbon).

Если приложение загрузило надстройку VSTO, значение LoadBehavior остается равным 9, но состояние надстройки в диалоговом окне Надстройки COM обновляется, указывая, что надстройка VSTO загружена.If the application successfully loads the VSTO Add-in, the LoadBehavior value remains 9, but the status of the VSTO Add-in in the COM Add-ins dialog box is updated to indicate that the VSTO Add-in is currently loaded. Если при загрузке надстройки VSTO возникает ошибка, значение LoadBehavior меняется на 8.If an error occurs when loading the VSTO Add-in, the LoadBehavior value changes to 8.
1616 ЗагруженLoaded Загрузить в первый раз, в дальнейшем загружать по запросуLoad first time, then load on demand Установите это значение, если надстройку VSTO нужно загружать по запросу.Set this value if you want your VSTO Add-in to be loaded on demand. Приложение загружает надстройку VSTO при первом запуске приложения пользователем.The application loads the VSTO Add-in when the user runs the application for the first time. При следующем запуске приложения пользователем будут загружаться все элементы пользовательского интерфейса, определенные надстройкой VSTO, но сама надстройка VSTO не будет загружена, пока пользователь не щелкнет связанный с ней элемент пользовательского интерфейса.The next time the user runs the application, the application loads any UI elements that are defined by the VSTO Add-in, but the VSTO Add-in is not loaded until the user clicks a UI element that is associated with the VSTO Add-in.

Если приложение впервые успешно загружает надстройку VSTO, значение LoadBehavior остается равным 16 и надстройка загружается.When the application successfully loads the VSTO Add-in for the first time, the LoadBehavior value remains 16 while the VSTO Add-in is loaded. После завершения работы приложения значение LoadBehavior меняется на 9.After the application closes, the LoadBehavior value changes to 9.

См. такжеSee also