Поделиться через

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

  • Статья

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

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

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

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

  • Написание кода, который использует объектную модель Word для добавления текста в документ при его сохранении.

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

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

    Примечание.

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

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

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

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

Создание нового проекта надстройки VSTO для Word в Visual Studio

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

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

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

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

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

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

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

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

Написание кода для добавления текста в сохраненный документ

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

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

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

Добавление абзаца текста в сохраненный документ

  1. В файл кода ThisAddIn добавьте в класс ThisAddIn указанный ниже код. Новый код определяет обработчик событий для события DocumentBeforeSave, которое возникает при сохранении документа.

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

    void Application_DocumentBeforeSave(Word.Document Doc, ref bool SaveAsUI, ref bool Cancel)
{
    Doc.Paragraphs[1].Range.InsertParagraphBefore();
    Doc.Paragraphs[1].Range.Text = "This text was added by using code.";
}

    Примечание.

    Этот код использует значение индекса 1 для доступа к первому абзацу в коллекции Paragraphs. Хотя Visual Basic и Visual C# используют массивы, которые начинаются с 0, нижней границей массива для большинства коллекций в объектной модели Word является 1. Дополнительные сведения см. в статье "Написание кода в решениях Office".

  2. Если используется C#, добавьте в обработчик событий ThisAddIn_Startup указанный ниже код. Он используется для подключения обработчика событий Application_DocumentBeforeSave к событию DocumentBeforeSave .

    this.Application.DocumentBeforeSave += 
    new Word.ApplicationEvents4_DocumentBeforeSaveEventHandler(Application_DocumentBeforeSave);

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

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

  • Параметр Doc обработчика событий для события DocumentBeforeSave . Параметр Doc является объектом Document, который представляет сохраненный документ. Дополнительные сведения см. в обзоре объектной модели Word.

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

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

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

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

  2. В Word сохраните активный документ.

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

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

  4. Закройте Word.

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

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

Очистка завершенного проекта на компьютере разработчика

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

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

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

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

  • Задачи программирования, относящиеся к надстройкам WORD VSTO: решения Word.

  • Использование объектной модели Word: обзор объектной модели Word.

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

  • Создание и отладка надстроек VSTO для Word: создание решений Office.

  • Развертывание надстроек VSTO для Word: развертывание решения Office.

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