Пошаговое руководство. Развертывание настройки на уровне документа с помощью файла установщика Windows (система 2003)

Статья
04/28/2010

Обновлен: Ноябрь 2007

Применение
Сведения в данном разделе относятся только к указанным проектам Visual Studio Tools for Office и версиям приложений Microsoft Office. Тип проекта Проекты уровня документа Версия Microsoft Office Microsoft Office 2003 Дополнительные сведения см. в разделе Доступность функций по типам приложений и проектов.

Сведения в данном разделе относятся только к указанным проектам Visual Studio Tools for Office и версиям приложений Microsoft Office.

Тип проекта

Проекты уровня документа

Версия Microsoft Office

Microsoft Office 2003

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

В данном пошаговом руководстве демонстрируется процесс создания файла установщика Microsoft Windows (MSI-файла), используемого для развертывания настройки на уровне документа. Дополнительные сведения о настройках уровня документа см. в разделе Архитектура настроек на уровне документа.

В данном пошаговом руководстве представлены указанные ниже задачи.

Создание проекта программы установки, используемого для построения файла установщика Windows.
Изменение проекта программы установки таким образом, чтобы файл установщика Windows устанавливал необходимое решение Visual Studio Tools for Office.
Добавление в проект программы установки действия, при котором файл установщика Windows изменяет манифест приложения, внедренный в документ решения Visual Studio Tools for Office.

В данном пошаговом руководстве предполагается, что на целевом компьютере уже установлены компоненты, необходимые для запуска решений Visual Studio Tools for Office. Создаваемый файл установщика Windows не проверяет наличие этих компонентов и не устанавливает их. Сведения об установке необходимых компонентов см. в статье Развертывание пакета Visual Studio 2005 Tools для решений Office Second Edition с использованием установщика Windows (на английском языке). Сведения о компонентах, необходимых для запуска решений Visual Studio Tools for Office, см. в разделе Практическое руководство. Подготовка компьютеров пользователей для выполнения решений (система 2003)..

Примечание.
Перед запуском решения необходимо предоставить полное доверие в политике безопасности конечного пользователя сборкам, используемым в решениях Visual Studio Tools for Office. Создаваемый в данном пошаговом руководстве файл установщика Windows не развертывает политику безопасности, необходимую для запуска решения. Сведения о том, как добавить настраиваемое действие для предоставления доверия сборке настройки, см. в статье Развертывание пакета Visual Studio 2005 Tools для решений Office Second Edition с использованием установщика Windows (на английском языке). Сведения о безопасности для решений Visual Studio Tools for Office см. в разделах Требования безопасности при выполнении решений Office (для системы 2003) и Рекомендации по безопасности для решений Office (система 2003). Сведения о настройке политики безопасности на компьютерах конечных пользователей см. в разделе Развертывание политики безопасности.

Перед запуском решения необходимо предоставить полное доверие в политике безопасности конечного пользователя сборкам, используемым в решениях Visual Studio Tools for Office. Создаваемый в данном пошаговом руководстве файл установщика Windows не развертывает политику безопасности, необходимую для запуска решения. Сведения о том, как добавить настраиваемое действие для предоставления доверия сборке настройки, см. в статье Развертывание пакета Visual Studio 2005 Tools для решений Office Second Edition с использованием установщика Windows (на английском языке). Сведения о безопасности для решений Visual Studio Tools for Office см. в разделах Требования безопасности при выполнении решений Office (для системы 2003) и Рекомендации по безопасности для решений Office (система 2003). Сведения о настройке политики безопасности на компьютерах конечных пользователей см. в разделе Развертывание политики безопасности.

Обязательные компоненты

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

Visual Studio Tools for Office (необязательный компонент Visual Studio 2008 Professional и Visual Studio Team System);
Microsoft Office Word 2003 или Microsoft Office Excel 2003.

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

Создайте на этом этапе проект книги Excel. Если вы хотите выполнить инструкции данного пошагового руководства для существующего решения Word или Excel, перейдите к разделу "Создание проекта программы установки" и замените во всех примерах кода и инструкциях имя проекта ExcelDeployment на имя своего проекта.

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

Создайте проект книги Excel с именем ExcelDeployment, используя шаблон проекта для Office 2003.

В мастере выберите Создать новый документ. Дополнительные сведения см. в разделе Практическое руководство. Создание проектов Visual Studio Tools for Office.

Созданная книга Excel открывается в конструкторе Visual Studio. Проект ExcelDeployment добавляется в Обозреватель решений.

Добавление кода для книги

В рамках данного фрагмента необходимо написать код для проверки работоспособности решения при открытии документа. Добавьте в обработчик событий Startup книги окно сообщения.

Добавление окна сообщения в обработчик событий инициализации

В Обозревателе решений щелкните правой кнопкой мыши файл ThisWorkbook.vb или ThisWorkbook.cs и выберите в контекстном меню пункт Просмотреть код.

Чтобы вывести в процессе инициализации окно сообщения, добавьте в обработчик событий Startup класса ThisWorkbook приведенный ниже код.

Private Sub ThisWorkbook_Startup(ByVal sender As Object, ByVal e As System.EventArgs) _
    Handles Me.Startup

    MessageBox.Show("The workbook is deployed successfully.")
End Sub

private void ThisWorkbook_Startup(object sender, System.EventArgs e)
{
    MessageBox.Show("The workbook is deployed successfully.");
}

Чтобы запустить проект, нажмите клавишу F5.

Запустится приложение Excel и откроется окно сообщения.
Закройте окно сообщения.
Закройте приложение Excel.

Создание проекта программы установки

В проектах программ установки содержатся файлы и код, который можно скомпилировать и создать для решения файл установщика Windows. Дополнительные сведения см. в разделе Проекты установки.

Создание для решения проекта программы установки

Щелкните узел решения в Обозревателе решений правой кнопкой мыши.
Выберите в контекстном меню пункт Добавить, а затем — пункт Новый проект.

Откроется диалоговое окно Добавление нового проекта.
В области Типы проектов разверните узел Другие и выберите пункт Установка и развертывание.
В области Шаблоны выберите Проект установки.
Назовите проект ExcelSetup.
Нажмите кнопку ОК.

В Обозревателе решений появится проект установки. По умолчанию файл установщика Windows, создаваемый с помощью данного проекта установки, включает диалоговое окно, с помощью которого пользователь может указать папку установки решения. Дополнительные сведения см. в разделе Диалоговое окно "Папка установки" в пользовательском интерфейсе.

Добавление в проект установки книги и сборки решения

Основные выходные данные проекта ExcelDeployment — это книга и сборка решения. Добавьте эти компоненты в проект установки.

Добавление документа и сборки в проект установки

Щелкните в Обозревателе решений правой кнопкой мыши узел Проект ExcelSetup.
Выберите в контекстном меню пункт Просмотреть, а затем — пункт Файловая система.
Щелкните в области слева правой кнопкой мыши элемент Папка приложения.
Выберите в контекстном меню пункт Добавить, а затем — пункт Выходные данные проекта.
Выберите в поле Проект пункт ExcelDeployment.
Выберите в списке типов выходных данных пункт Основные выходные данные.
Нажмите кнопку ОК.

В области справа появятся выходные данные и зависимости проекта.
В Обозревателе решений разверните в узле ExcelSetup проекта узел Обнаруженные зависимости.
Щелкните правой кнопкой мыши каждую зависимость, кроме Microsoft .NET Framework, и выберите в контекстном меню пункт Исключить.

Создание проекта настраиваемого действия

Настраиваемые действия — это одна из возможностей установщика Windows. Эти действия используются для запуска в конце процесса установки кода, выполняющего действия, которые невозможно выполнить в процессе установки. Дополнительные сведения см. в разделе Настраиваемые действия.

Создание проекта настраиваемого действия

Щелкните узел решения в Обозревателе решений правой кнопкой мыши.
Выберите в контекстном меню пункт Добавить, а затем — пункт Новый проект.

Откроется диалоговое окно Добавление нового проекта.
В области Типы проектов разверните узел используемого языка программирования и выберите пункт Windows.
В области Шаблоны выберите пункт Библиотека классов.
Назовите проект ExcelCustomAction.
Нажмите кнопку ОК.

В Обозревателе решений появится новый проект.
В Обозревателе решений щелкните в проекте ExcelCustomAction правой кнопкой мыши файл Class1.vb или Class1.cs и выберите пункт Удалить. Этот файл не используется в данном пошаговом руководстве.

Создание настраиваемого действия для изменения манифеста приложения

Ранее в данном руководстве при запуске проекта по нажатию клавиши F5 процесс построения завершился изменением манифеста приложения, внедренного в книгу, чтобы указать относительный путь к сборке. Если после установки книга и сборка будут находиться в одной папке, изменять манифест приложения не требуется, и этот этап можно пропустить. Однако если после установки решения необходимо предоставить пользователю возможность переместить книгу в другую папку, необходимо изменить манифест приложения таким образом, чтобы в нем указывался полный путь к сборке.

После завершения процесса установки необходимо обновить манифест приложения, внедренный в документ решения Visual Studio Tools for Office, выполнив настраиваемое действие, поскольку местоположение сборки решения будет неизвестно до тех пор, пока пользователь не укажет это местоположение в процессе установки. Измените внедренный манифест приложения с помощью класса ServerDocument. Чтобы воспользоваться классом ServerDocument в проекте установки, добавьте код в класс Installer проекта настраиваемого действия.

Создание настраиваемого действия по изменению манифеста приложения

Щелкните в Обозревателе решений правой кнопкой мыши проект ExcelCustomAction.
Выберите в контекстном меню пункт Добавить, а затем — пункт Новый элемент.

Откроется диалоговое окно Добавление нового элемента.
Выберите пункт Класс установщика и присвойте ему имя ManifestEditor.
Добавьте в проект ExcelCustomAction ссылку на сборку Microsoft.VisualStudio.Tools.Applications.Runtime.
В Обозревателе решений щелкните правой кнопкой мыши файл ManifestEditor.cs или ManifestEditor.vb и выберите в контекстном меню команду Просмотреть код.
Добавьте в начало файла с кодом приведенный ниже оператор Imports или using.
```
Imports Microsoft.VisualStudio.Tools.Applications.Runtime
```
```
using Microsoft.VisualStudio.Tools.Applications.Runtime;
```

Добавьте в класс ManifestEditor приведенный ниже код.

В этом коде переопределяется метод Install, используемый для выполнения в процессе установки настраиваемых действий. В коде свойству AssemblyPath присваивается указанная пользователем папка установки. Указанные пользователем путь установки и имя документа извлекаются из свойства Parameters.

Public Overrides Sub Install(ByVal stateSaver As System.Collections.IDictionary)
    UpdateApplicationManifest()
    MyBase.Install(stateSaver)
End Sub

Private Sub UpdateApplicationManifest()

    ' Get the parameters passed to the task.
    Dim targetDir As String = Me.Context.Parameters("targetdir")
    Dim documentName As String = Me.Context.Parameters("documentname")
    Dim assemblyName As String = Me.Context.Parameters("assemblyname")

    ' Get the application manifest from the document.
    Dim documentPath As String = System.IO.Path.Combine(targetDir, documentname)
    Dim serverDocument1 As ServerDocument = New ServerDocument(documentPath, _
            System.IO.FileAccess.ReadWrite)

    Try
        Dim appManifest1 As AppManifest = serverDocument1.AppManifest
        Dim assemblyPath As String = System.IO.Path.Combine(targetDir, assemblyName)
        appManifest1.Dependency.AssemblyPath = assemblyPath
        serverDocument1.Save()

    Finally
        If Not serverDocument1 Is Nothing Then
            serverDocument1.Close()
        End If
    End Try
End Sub

// Override the Install method to update the customization location
// in the application manifest.
public override void Install(System.Collections.IDictionary stateSaver)
{
    UpdateApplicationManifest();
    base.Install(stateSaver);
}

// Update the application manifest according to the the install location.
private void UpdateApplicationManifest()
{
    // Get the parameters passed to the task.
    string targetDir = this.Context.Parameters["targetdir"];
    string documentName = this.Context.Parameters["documentname"];
    string assemblyName = this.Context.Parameters["assemblyname"];

    // Get the application manifest from the document.
    string documentPath = System.IO.Path.Combine(targetDir, documentName);
    ServerDocument serverDocument1 = new ServerDocument(documentPath,
        System.IO.FileAccess.ReadWrite);

    try
    {
        AppManifest appManifest1 = serverDocument1.AppManifest;
        string assemblyPath = System.IO.Path.Combine(targetDir, assemblyName);
        appManifest1.Dependency.AssemblyPath = assemblyPath;
        serverDocument1.Save();
    }
    finally
    {
        if (serverDocument1 != null)
        {
            serverDocument1.Close();
        }
    }
}

Щелкните в Обозревателе решений правой кнопкой мыши проект ExcelCustomAction и выберите пункт Построение.

Добавление в проект установки настраиваемого действия

Теперь можно включить в файл установщика Windows настраиваемое действие, изменяющее манифест приложения. Для этого добавьте основные выходные данные проекта ExcelCustomAction в проект установки.

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

Щелкните в Обозревателе решений правой кнопкой мыши узел Проект ExcelSetup.
Выберите в контекстном меню пункт Просмотреть, а затем — пункт Настраиваемые действия.
В Редакторе настраиваемых действий щелкните правой кнопкой узел Установка и выберите пункт Добавить настраиваемое действие.
В поле Искать в выберите пункт Папка приложения и нажмите кнопку Добавить выходные данные.
Выберите в поле Проект пункт ExcelCustomAction.
Выберите в списке типов выходных данных пункт Основные выходные данные и нажмите кнопку ОК.
Убедитесь в том, что Основные выходные данные проекта ExcelCustomAction (активный) были добавлены в список основных выходных данных проекта установки, и нажмите кнопку ОК.
Разверните в Редакторе настраиваемых действий узел Установка.
Щелкните правой кнопкой мыши Основные выходные данные проекта ExcelCustomAction (активный) и выберите пункт Окно "Свойства".
В окне Свойства присвойте свойству CustomActionData указанную ниже строку.
```
/targetdir="[TARGETDIR]\" /documentname="ExcelDeployment.xls" /assemblyname="ExcelDeployment.dll"
```
Сведения о свойстве CustomActionData см. в разделе Свойство CustomActionData.
Щелкните правой кнопкой мыши в Обозревателе решенийПроект ExcelSetup и выберите пункт Построения.

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

Теперь можно протестировать проект, чтобы убедиться в том, что решение было установлено при запуске файла установщика Windows на компьютере разработчика.

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

Щелкните правой кнопкой мыши в Обозревателе решенийПроект ExcelSetup и выберите пункт Выполнить.
Следуйте инструкциям мастера установки и укажите папку установки на компьютере разработчика.
Откройте книгу Excel из папки установки.
Проверьте, появилось ли окно сообщения.

См. также

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

Пошаговое руководство. Развертывание настройки на уровне документа с помощью файла установщика Windows (система 2003)

Обязательные компоненты

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

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

Добавление кода для книги

Добавление окна сообщения в обработчик событий инициализации

Создание проекта программы установки

Создание для решения проекта программы установки

Добавление в проект установки книги и сборки решения

Добавление документа и сборки в проект установки

Создание проекта настраиваемого действия

Создание проекта настраиваемого действия

Создание настраиваемого действия для изменения манифеста приложения

Создание настраиваемого действия по изменению манифеста приложения

Добавление в проект установки настраиваемого действия

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

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

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

См. также

Задачи

Основные понятия

Другие ресурсы

Дополнительные ресурсы