Создание надстройки excel в visual studio
This introductory walkthrough shows you how to create an application-level Add-in for Microsoft Office Excel. The features that you create in this kind of solution are available to the application itself, regardless of which workbooks are open.
Applies to: The information in this topic applies to VSTO Add-in projects for Excel. For more information, see Features available by Office application and project type.
Interested in developing solutions that extend the Office experience across multiple platforms? Check out the new Office Add-ins model. 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.
This walkthrough illustrates the following tasks:
Creating an Excel VSTO Add-in project for Excel.
Writing code that uses the object model of Excel to add text to a workbook when it is saved.
Building and running the project to test it.
Cleaning up the completed project so that the VSTO Add-in no longer runs automatically on your development computer.
Your computer might show different names or locations for some of the Visual Studio user interface elements in the following instructions. The Visual Studio edition that you have and the settings that you use determine these elements. For more information, see Personalize the IDE.
Prerequisites
You need the following components to complete this walkthrough:
An edition of Visual Studio that includes the Microsoft Office developer tools. For more information, see Configure a computer to develop Office solutions.
Excel 2013 or Excel 2010.
Create the project
To create a new Excel VSTO Add-in project in Visual Studio
Start Visual Studio.
On the File menu, point to New, and then click Project.
Under the expanded Office/SharePoint node, select the Office Add-ins node.
In the list of project templates, select Excel 2010 Add-in or Excel 2013 Add-in.
In the Name box, type FirstExcelAddIn.
Click OK.
Visual Studio creates the FirstExcelAddIn project and opens the ThisAddIn code file in the editor.
Write code to add text to the saved workbook
Next, add code to the ThisAddIn code file. The new code uses the object model of Excel to insert boilerplate text in the first row of the active worksheet. The active worksheet is the worksheet that is open when the user saves the workbook. By default, the ThisAddIn code file contains the following generated code:
A partial definition of the ThisAddIn class. This class provides an entry point for your code and provides access to the object model of Excel. For more information, see Program VSTO Add-ins. The remainder of the ThisAddIn class is defined in a hidden code file that you should not modify.
The ThisAddIn_Startup and ThisAddIn_Shutdown event handlers. These event handlers are called when Excel loads and unloads your VSTO Add-in. Use these event handlers to initialize your VSTO Add-in when it is loaded, and to clean up resources used by your Add-in when it is unloaded. For more information, see Events in Office projects.
To add a line of text to the saved workbook
In the ThisAddIn code file, add the following code to the ThisAddIn class. The new code defines an event handler for the WorkbookBeforeSave event, which is raised when a workbook is saved.
When the user saves a workbook, the event handler adds new text at the start of the active worksheet.
To modify the workbook when it is saved, the previous code examples use the following objects:
The Application field of the ThisAddIn class. The Application field returns a Application object, which represents the current instance of Excel.
The Wb parameter of the event handler for the WorkbookBeforeSave event. The Wb parameter is a Workbook object, which represents the saved workbook. For more information, see Excel object model overview.
Test the project
To test the project
Press F5 to build and run your project.
When you build the project, the code is compiled into an assembly that is included in the build output folder for the project. Visual Studio also creates a set of registry entries that enable Excel to discover and load the VSTO Add-in, and it configures the security settings on the development computer to enable the VSTO Add-in to run. For more information, see Build Office solutions.
In Excel, save the workbook.
Verify that the following text is added to the workbook.
This text was added by using code.
Clean up the project
When you finish developing a project, remove the VSTO Add-in assembly, registry entries, and security settings from your development computer. Otherwise, the VSTO Add-in will continue to run every time that you open Excel on your development computer.
To clean up the completed project on your development computer
- In Visual Studio, on the Build menu, click Clean Solution.
Next steps
Now that you have created a basic VSTO Add-in for Excel, you can learn more about how to develop VSTO Add-ins from these topics:
General programming tasks that you can perform in VSTO Add-ins: Program VSTO Add-ins.
Programming tasks that are specific to Excel VSTO Add-ins: Excel solutions.
Using the object model of Excel: Excel object model overview.
Customizing the user interface (UI) of Excel, for example, by adding a custom tab to the Ribbon or creating your own custom task pane: Office UI customization.
Интересуетесь разработкой решений, расширяющих возможности Office на нескольких платформах? Ознакомьтесь с новой моделью надстроек Office. Надстройки Office имеют небольшой объем по сравнению с надстройками и решениями VSTO, и их можно создавать с помощью практически любой технологии веб-программирования, такой как HTML5, JavaScript, CSS3 и XML.
последние сведения о разработке Office см. в центре разработчиков Microsoft Office.
Содержание раздела
Ссылки на сведения о настройке компьютера разработчика для создания решений Office, первых шагах по созданию решений Office, а также новых возможностях разработки решений Office в Visual Studio.
Ссылки на сведения о процессе обновления для проектов, созданных с помощью предыдущих версий Visual Studio.
Ссылки на сведения о том, как работают решения Office, в том числе о настройках уровня документа и надстройках VSTO.
Сведения о создании проектов Office и их настройке в Visual Studio.
Сведения об использовании управляемого кода в решениях Office, в том числе о настройке пользовательского интерфейса Office, о работе с данными и об устранении неполадок.
Сведения об автоматизации работы Excel, о создании решений Excel, а также о характерных для Excel проблемах, связанных с глобализацией.
Сведения о способах создания шаблонов форм и надстроек VSTO для InfoPath.
Сведения об автоматизации работы Outlook и о создании надстроек VSTO и областей форм для Outlook.
Сведения об автоматизации работы PowerPoint и о создании надстроек VSTO PowerPoint.
содержит сведения об автоматизации Microsoft Office проекта и создании надстроек VSTO проектов.
Сведения об автоматизации работы Visio и о создании надстроек VSTO Visio.
Сведения об автоматизации работы Word и о создании решений Word.
Сведения о различиях между созданием проектов Office и других типов проектов в Visual Studio.
Сведения о различиях между отладкой проектов Office и других типов проектов в Visual Studio.
Сведения о работе функций обеспечения безопасности в решениях Office.
Сведения о том, как делать решения Office доступными для пользователей, а также об основных аспектах, которые необходимо учитывать при выборе метода развертывания.
Ссылки на примеры приложений и разделы с пошаговыми инструкциями по выполнению типовых задач.
Ссылки на сведения об интерфейсах COM, которые можно использовать для выполнения таких действий, как загрузка и выгрузка управляемых надстроек VSTO в приложениях Office.
Связанные разделы
разработка Office с помощью портала Visual Studio разработчиков Предоставляет дополнительные ресурсы, такие как технические статьи, видеоролики и блоги.
центр разработчиков Visual Studio предоставляет дополнительные Visual Studio ресурсы, такие как технические статьи, видеоролики и блоги.
раздел "разработка Microsoft Office" библиотеки MSDN область библиотеки MSDN, в которой можно найти статьи и справочную документацию по разработке решений для нескольких версий Office (не только для Office разработки с помощью Visual Studio).
Разработка приложений в Visual Studio содержит ссылки на разделы, в которых объясняется, как можно использовать Visual Studio для проектирования, разработки, отладки и развертывания веб-приложений, веб-служб XML и традиционных клиентских приложений.
В этом вводном пошаговом руководстве показано, как создавать надстройки уровня приложения для Microsoft Office Excel. Функции, создаваемые в подобном решении, доступны для приложения независимо от того, какие книги открыты.
Применимо к: сведения в этом разделе относятся к VSTO добавления - в проекты для Excel. дополнительные сведения см. в разделе функции, доступные по Office приложении и типу проекта.
Интересуетесь разработкой решений, расширяющих возможности Office на нескольких платформах? Ознакомьтесь с новой моделью надстроек Office. Надстройки Office имеют небольшой объем по сравнению с надстройками и решениями VSTO, и их можно создавать с помощью практически любой технологии веб-программирования, такой как HTML5, JavaScript, CSS3 и XML.
В этом пошаговом руководстве описаны следующие задачи:
Создание проекта надстройки VSTO Excel для Excel.
Написание кода с использованием объектной модели Excel, которая при сохранении книги добавляет в нее текст.
Построение и запуск проекта для тестирования.
Удаление завершенного проекта для прекращения автоматического запуска надстройки VSTO на компьютере разработчика.
Отображаемые на компьютере имена или расположения некоторых элементов пользовательского интерфейса Visual Studio могут отличаться от указанных в следующих инструкциях. Это зависит от имеющегося выпуска Visual Studio и используемых параметров. Дополнительные сведения см. в разделе Персонализация среды IDE.
Предварительные требования
Для выполнения этого пошагового руководства требуются следующие компоненты:
Выпуск Visual Studio, включающий инструменты разработчика Microsoft Office. Дополнительные сведения см. в статье Настройка компьютера для разработки решений Office.
Excel 2013 или Excel 2010.
Создание проекта
Создание проекта надстройки VSTO Excel в Visual Studio
Запустите среду Visual Studio.
В меню Файл укажите Создать, затем нажмите Проект.
В развернутом узле Office/SharePoint выберите узел Надстройки Office .
В списке шаблонов проектов выберите Надстройку Excel 2010 или Надстройку Excel 2013.
В поле Имя введите FirstExcelAddIn.
Нажмите OK.
Visual Studio создает проект проект firstexceladdin и открывает файл кода ThisAddIn в редакторе.
Написание кода для добавления текста в сохраненную книгу
Затем добавьте код в файл ThisAddIn. Новый код использует объектную модель Excel для вставки стандартного текста в первую строку активного листа. Активным является лист, открытый в момент сохранения книги пользователем. По умолчанию файл кода ThisAddIn содержит следующий созданный код:
Частичное определение класса ThisAddIn . Этот класс предоставляет точку входа для кода и обеспечивает доступ к объектной модели Excel. дополнительные сведения см. в статье надстройки программы VSTO. Оставшаяся часть ThisAddIn класса определяется в скрытом файле кода, который не следует изменять.
Обработчики событий ThisAddIn_Startup и ThisAddIn_Shutdown . Эти обработчики событий вызываются, когда Excel загружает и выгружает надстройку VSTO. Их можно использовать для инициализации надстройки VSTO в процессе ее загрузки, а также для освобождения используемых надбавкой ресурсов при ее выгрузке. дополнительные сведения см. в разделе события в Office проектах.
Добавление строки текста в сохраненную книгу
В файл кода ThisAddIn добавьте в класс ThisAddIn указанный ниже код. Новый код определяет обработчик событий для события WorkbookBeforeSave , которое возникает при сохранении книги.
Когда пользователь сохраняет книгу, обработчик событий добавляет новый текст в начало активного листа.
Для изменения книги при ее сохранении в приведенных выше примерах кода используются следующие объекты:
Поле Application класса ThisAddIn . Поле Application возвращает объект Application , который представляет текущий экземпляр Excel.
Параметр Wb обработчика событий для события WorkbookBeforeSave . Параметр Wb является объектом Workbook , который представляет сохраняемую книгу. дополнительные сведения см. в статье общие сведения об объектной модели Excel.
Тестирование проекта
Тестирование проекта
Нажмите клавишу F5 для построения и запуска проекта.
При построении проекта код компилируется в сборку, которая включается в выходную папку сборки для проекта. Visual Studio также создает ряд записей реестра, которые позволяют Excel обнаружить и загрузить надстройку VSTO, и настраивает параметры безопасности на компьютере разработчика, разрешая запуск надстройки VSTO. дополнительные сведения см. в разделе Build Office solutions.
Сохраните книгу в Excel.
Убедитесь, что в книгу добавляется указанный ниже текст.
Этот текст добавляется с помощью кода.
Очистить проект
Завершив разработку проекта, удалите с компьютера сборку надстройки VSTO, записи реестра и параметры безопасности. В противном случае надстройка VSTO будет запускаться при каждом открытии программы Excel на компьютере разработчика.
Очистка завершенного проекта на компьютере разработчика
- В Visual Studio в меню Построение выберите пункт Очистить решение.
Дальнейшие действия
Теперь, когда вы создали базовую надстройку VSTO для Excel, изучите более подробную информацию о разработке надстроек VSTO в следующих разделах.
общие задачи программирования, которые можно выполнять в VSTO надстроек: программы VSTO надстройки.
задачи программирования, характерные для Excel VSTO надстройки: Excel решения.
настройка пользовательского интерфейса Excel, например, путем добавления пользовательской вкладки на ленту или создания собственной настраиваемой области задач: Office настройки пользовательского интерфейса.
В этой статье вы ознакомитесь с процессом создания надстройки области задач Excel.
Создание надстройки
Можно создать надстройку Office с помощью генератора Yeoman для надстроек Office или Visual Studio. Генератор Yeoman создает проект Node.js, которым можно управлять с помощью Visual Studio Code или любого другого редактора, а Visual Studio создает решение Visual Studio. Выберите вкладку с нужным вариантом и следуйте инструкциям, чтобы создать надстройку и протестировать ее локально.
Чтобы создать надстройку, в которой используется единый вход (SSO), с помощью генератора Yeoman, см. инструкции в кратком руководстве по единому входу (SSO).
Необходимые условия
Если вы не знакомы с Node.js или NPM, начните с настройки среды разработки.
Последняя версия Yeoman и генератора Yeoman для надстроек Office. Выполните в командной строке указанную ниже команду, чтобы установить эти инструменты глобально.
Даже если вы уже установили генератор Yeoman, рекомендуем обновить пакет до последней версии из npm.
Создание проекта надстройки
Выполните следующую команду, чтобы создать проект надстройки с помощью генератора Yeoman.
При выполнении команды yo office может появиться запрос о политиках сбора данных генератора Yeoman и средств CLI надстройки Office. Используйте предоставленные сведения, чтобы ответить на запросы подходящим образом.
При появлении запроса предоставьте следующую информацию для создания проекта надстройки.
- Выберите тип проекта: Office Add-in Task Pane project
- Выберите тип сценария: Javascript
- Как вы хотите назвать надстройку? My Office Add-in
- Какое клиентское приложение Office должно поддерживаться? Excel
После завершения работы мастера генератор создаст проект и установит вспомогательные компоненты Node.
Вы можете игнорировать инструкции по дальнейшим действиям, предоставляемые генератором Yeoman после создания проекта надстройки. Пошаговые инструкции этой статьи содержат все сведения, необходимые для завершения этого учебного курса.
Знакомство с проектом
Проект надстройки, который вы создали с помощью генератора Yeoman, содержит образец кода для простой надстройки области задач. Если вы хотите ознакомиться с компонентами проекта надстройки, откройте проект в редакторе кода и просмотрите файлы, перечисленные ниже. Когда вы будете готовы попробовать собственную надстройку, перейдите к следующему разделу.
- Файл ./manifest.xml в корневом каталоге проекта определяет настройки и возможности надстройки. Подробности о файле manifest.xml см. в статье XML-манифест надстроек Office.
- Файл ./src/taskpane/taskpane.html содержит разметку HTML для области задач.
- Файл ./src/taskpane/taskpane.css содержит код CSS, который применяется к содержимому области задач.
- Файл ./src/taskpane/taskpane.js содержит код API JavaScript для Office, который упрощает взаимодействие между областью задач и клиентским приложением Office.
Проверка
Перейдите к корневой папке проекта.
Выполните следующие действия, чтобы запустить локальный веб-сервер и загрузить неопубликованную надстройку.
Если вы тестируете надстройку на компьютере Mac, перед продолжением выполните указанную ниже команду. После выполнения этой команды запустится локальный веб-сервер.
Чтобы проверить надстройку в Excel, выполните приведенную ниже команду в корневом каталоге своего проекта. При этом запускается локальный веб-сервер и открывается приложение Excel с загруженной надстройкой.
Чтобы проверить надстройку в Excel в браузере, выполните приведенную ниже команду в корневом каталоге своего проекта. После выполнения этой команды запустится локальный веб-сервер. Замените "" на URL-адрес документа Excel в OneDrive или библиотеке SharePoint, для которой у вас есть разрешения.
Ниже приведены примеры.
Если надстройка не загружена в документе, вручную разгрузите ее вручную, следуя инструкциям в Sideload Officeнадстройки в Office в Интернете вручную .
В Excel выберите вкладку Главная и нажмите кнопку Показать область задач на ленте, чтобы открыть область задач надстройки.
Выберите любой диапазон ячеек на листе.
Внизу области задач выберите ссылку Выполнить, чтобы задать выбранному диапазону желтый цвет.
Дальнейшие действия
Поздравляем, вы успешно создали надстройку панели задач Excel! Чтобы узнать больше о возможностях надстроек Excel и создать более сложную надстройку, воспользуйтесь руководством по надстройкам Excel.
Необходимые компоненты
Visual Studio 2019 или более поздней версии с установленной рабочей нагрузкой Разработка надстроек для Office и SharePoint.
Если вы уже установили Visual Studio, используйте установщик Visual Studio, чтобы убедиться, что также установлена рабочая нагрузка Разработка надстроек для Office и SharePoint.
Пакет Office, подключенный к подписке Microsoft 365 (включая Office в Интернете).
Если у вас еще нет Office, вы можете присоединиться к программе для разработчиков Microsoft 365, чтобы получить бесплатную 90-дневную возобновляемую подписку на Microsoft 365 для использования в процессе разработки.
Создание проекта надстройки
В Visual Studio выберите пункт Создать проект.
Используя поле поиска, введите надстройка. Выберите вариант Веб-надстройка Excel и нажмите кнопку Далее.
Присвойте проекту имя ExcelWebAddIn1 и выберите Создать.
В диалоговом окне Создание надстройки Office выберите Добавить новые функции в Excel, а затем нажмите кнопку Готово, чтобы создать проект.
Visual Studio создаст решение, и в обозревателе решений появятся два соответствующих проекта. В Visual Studio откроется файл Home.html.
Обзор решения Visual Studio
После завершения работы мастера Visual Studio создает решение, которое содержит два проекта.
Проект | Описание |
---|---|
Проект надстройки | Содержит только XML-файл манифеста, который содержит все параметры, описывающие надстройку. Эти параметры помогают приложению Office определять, когда и где должна активироваться надстройка. Visual Studio создает содержимое этого файла за вас, чтобы вы могли сразу запустить проект и начать использовать надстройку. Вы можете изменить эти параметры в любой момент, изменив XML-файл. |
Проект веб-приложения | Содержит страницы контента надстройки, включающие все файлы и ссылки на файлы, необходимые для разработки страниц HTML и JavaScript с поддержкой Office. При разработке надстройки Visual Studio размещает веб-приложение на локальном сервере IIS. Для публикации надстройки этот проект веб-приложения нужно развернуть на веб-сервере. |
Обновление кода
Файл Home.html содержит HTML-контент, который будет отображаться в области задач надстройки. В файле Home.html замените элемент на приведенную ниже часть кода и сохраните файл.
Откройте файл Home.js в корневой папке проекта веб-приложения. Этот файл содержит скрипт надстройки. Замените все его содержимое указанным ниже кодом и сохраните файл.
Откройте файл Home.css в корневой папке проекта веб-приложения. Этот файл определяет специальные стили надстройки. Замените все его содержимое указанным ниже кодом и сохраните файл.
Обновление манифеста
Откройте Обозреватель решений, перейдите к проекту надстройки ExcelWebAddIn1, затем откройте каталог ExcelWebAddIn1Manifest. Этот каталог содержит ExcelWebAddIn1.xml (ваш файл манифеста). XML-файл манифеста определяет параметры и возможности надстройки. Дополнительные сведения о двух проектах, созданных решением Visual Studio, приведены ранее в разделе Обзор решения Visual Studio.
Элемент ProviderName содержит заполнитель. Замените его на свое имя.
Атрибут DefaultValue элемента DisplayName содержит заполнитель. Замените его на строку Моя надстройка Office.
Атрибут DefaultValue элемента Description содержит заполнитель. Замените его строкой Надстройка области задач для Excel.
Проверка
Протестируйте новую надстройку Excel в Visual Studio, нажав клавишу F5 или кнопку Запустить, чтобы запустить Excel с кнопкой надстройки Показать область задач на ленте. Надстройка будет размещена на локальном сервере IIS. Если вам будет предложено доверять сертификату, согласитесь, чтобы разрешить надстройке подключиться к приложению Office.
В Excel выберите вкладку Главная и нажмите кнопку Показать область задач на ленте, чтобы открыть область задач надстройки.
Выберите любой диапазон ячеек на листе.
В области задач нажмите кнопку Set color (Задать цвет), чтобы сделать выбранный диапазон зеленым.
Чтобы увидеть выходные данные console.log , нужен отдельный набор средств разработчика для консоли JavaScript. Дополнительные сведения о средствах F12 и средствах разработчика Microsoft Edge см. в статье Отладка надстроек с помощью средств разработчика для Internet Explorer, Отладка надстроек с помощью средств разработчика для устаревшей версии Microsoft Edge или Отладка надстроек с помощью средств разработчика в Microsoft Edge (на основе Chromium).
Дальнейшие действия
Поздравляем! Вы успешно создали надстройку области задач Excel! Теперь изучите дополнительные сведения о разработке надстроек Office с помощью Visual Studio.
В этой статье описано, как использовать Visual Studio для разработки надстроек Office. Если надстройка уже создана, можно перейти к разделу Разработка надстройки с помощью Visual Studio.
Вместо Visual Studio можно использовать генератор Yeoman для надстроек Office и VS Code для создания надстройки Office. Дополнительные сведения об этом выборе см. в разделе Создание надстройки Office.
Создание проекта надстройки с помощью Visual Studio
С помощью Visual Studio можно создавать надстройки Office для Excel, Outlook, Word и PowerPoint. Проект надстройки Office создается в рамках решения Visual Studio и использует HTML, CSS и JavaScript. Чтобы создать надстройку Office с помощью Visual Studio, следуйте указаниям из краткого руководства, соответствующего типу надстройки, которую нужно создать.
Visual Studio не поддерживает создание надстроек Office для OneNote или Project. Чтобы создавать надстройки Office для любого из этих приложений, потребуется использовать генератор Yeoman для надстроек Office, как описано в кратком руководстве по началу работы с OneNote и в кратком руководстве по началу работы с Project.
Разработка надстройки с помощью Visual Studio
В Visual Studio создается простая надстройка с ограниченными возможностями. Можно настроить надстройку, отредактировав файлы манифеста, HTML, JavaScript и CSS в Visual Studio. Общее описание структуры проекта и файлов в проекте надстройки, создаваемом в Visual Studio, см. в справочнике по Visual Studio в составе краткого руководства по началу работы, с помощью которого вы создали надстройку.
Надстройка Office представляет собой веб-приложение, поэтому для изменения надстройки требуются базовые навыки веб-разработки. Если вы впервые работаете с JavaScript, рекомендуем прочесть учебник Mozilla по JavaScript.
Чтобы настроить надстройку, вам нужно будет усвоить принципы, описанные в разделе Основные принципы > Разработка этой документации, а также принципы, описанные в соответствующем разделе документации приложения, для которого вы создаете надстройку (например, Excel).
Тестирование и отладка надстройки
Методы тестирования, отладки и устранения неполадок надстроек Office зависят от платформы. Дополнительные сведения см. в статьях Отладка надстроек Office в Visual Studio и Тестирование и отладка надстроек Office.
Публикация надстройки
Надстройка Office состоит из веб-приложения и файла манифеста. Веб-приложение определяет пользовательский интерфейс и функции надстройки, а манифест указывает расположение веб-приложения и определяет параметры и возможности надстройки.
В процессе разработки надстройки в Visual Studio эта надстройка запускается на локальном веб-сервере ( localhost ). Если надстройка работает нужным образом и вы готовы опубликовать ее для доступа других пользователей, выполните следующие действия.
Читайте также: