Demonstra Passo a passo: Implantando uma personalização em nível de documento usando um Windows Instalador de arquivos (sistema de 2003)

Artigo
08/25/2010

Se aplica a
As informações contidas neste tópico se aplicam apenas às especificado Ferramentas do Visual Studio para o Office projetos e as versões do Microsoft Office. Tipo de Projeto Projetos de nível de documento Versão do Microsoft Office Microsoft Office 2003 For more information, see Recursos disponíveis pelo aplicativo e o tipo de projeto.

As informações contidas neste tópico se aplicam apenas às especificado Ferramentas do Visual Studio para o Office projetos e as versões do Microsoft Office.

Tipo de Projeto

Projetos de nível de documento

Versão do Microsoft Office

Microsoft Office 2003

For more information, see Recursos disponíveis pelo aplicativo e o tipo de projeto.

Esta explicação passo a passo demonstra como criar um arquivo do Microsoft Windows Instalador (.msi) que pode ser usado para implantar uma personalização de nível de documento.Para obter mais informações sobre personalizações em nível de documento, consulte Arquitetura de personalizações de nível de documento.

Essa explicação passo a passo ilustra as seguintes tarefas:

Criando um projeto de instalação que você pode usar parComCompilação um arquivo do Windows Instalador.
Modificar o projeto de instalação para que o arquivo do Windows Instalador instala sua solução Ferramentas do Visual Studio para o Office.
Adicionando uma etapa no projeto de instalação para que o arquivo do Windows Instalador edita o manifesto do aplicativo incorporada no documento de solução Ferramentas do Visual Studio para o Office.

Esta explicação passo a passo pressupõe que o computador de destino já tenha pré-requisitos instalados para Executando soluções Ferramentas do Visual Studio para o Office.Você ComCompilação o arquivo do Windows Instalador não Marcar para ou instale esses pré-requisitos.Para obter informações sobre como instalar os pré-requisitos, consulte Implantando Visual Studio 2005 Tools for Office segundo Edition soluções usando o Windows Instalador.Para obter informações sobre quais são os pré-requisitos para Executando Ferramentas do Visual Studio para o Office soluções, consulte Como: Preparar os computadores de usuário final para Run Office Solutions (sistema de 2003).

Observação:
Assemblies em Soluções de Ferramentas do Visual Studio para o Office devem ser concedidas completo Confiar na diretiva de segurança do usuário final antes da solução será executado.O arquivo do Windows Instalador que é ComCompilação nesta explicação passo a passo não implantar a diretiva de segurança necessária para executar a solução.Para informações sobre como adicionar uma ação personalizada para conceder Confiar para o assembly de personalização, consulte Implantando Visual Studio 2005 Tools for Office segundo Edition soluções usando o Windows Instalador.Para obter informações sobre a segurança em Ferramentas do Visual Studio para o Office soluções, consulte Requisitos de segurança para executar o Office Solutions (sistema de 2003) e Práticas recomendadas para segurança in Office Solutions (sistema de 2003).Para obter informações sobre Configuração diretiva de segurança em computadores de usuários finais, consulte Implantação de diretiva de segurança.

Assemblies em Soluções de Ferramentas do Visual Studio para o Office devem ser concedidas completo Confiar na diretiva de segurança do usuário final antes da solução será executado.O arquivo do Windows Instalador que é ComCompilação nesta explicação passo a passo não implantar a diretiva de segurança necessária para executar a solução.Para informações sobre como adicionar uma ação personalizada para conceder Confiar para o assembly de personalização, consulte Implantando Visual Studio 2005 Tools for Office segundo Edition soluções usando o Windows Instalador.Para obter informações sobre a segurança em Ferramentas do Visual Studio para o Office soluções, consulte Requisitos de segurança para executar o Office Solutions (sistema de 2003) e Práticas recomendadas para segurança in Office Solutions (sistema de 2003).Para obter informações sobre Configuração diretiva de segurança em computadores de usuários finais, consulte Implantação de diretiva de segurança.

Pré-requisitos

Para completar este passo a passo, são necessários os seguintes componentes:

Ferramentas do Visual Studio para o Office (um componente opcional do O Visual Studio 2008 Professional e Visual Studio Team System).
Microsoft Office Word 2003 ou Microsoft Office Excel 2003.

Criando o projeto

Nesta etapa, Criar um projeto de pasta de trabalho do Excel.Se você quiser executar explicação passo a passo com uma solução existente do Word ou Excel, começar a explicação passo a passo no título Criando o projeto de instalação e, substitua o projeto nome ExcelDeployment com o nome do seu projeto no Todo o Código exemplos e instruções.

Para criar um novo projeto

Criar um projeto de pasta de trabalho do Excel com o nome ExcelDeployment, usando o modelo de projeto para o Office 2003.

No assistente, Selecionar Criar um documento novo.For more information, see Como: Criar o Visual Studio Tools para projetos do Office.

O Visual Studio abre a Novo pasta de trabalho do Excel no designer e adiciona o projeto de ExcelDeployment para Gerenciador de Soluções.

Adicionando código por trás da pasta de trabalho

O projeto precisa algum código para que você possa verificar se a solução está funcionando quando você Abrir o documento.Para esta explicação passo a passo, Adicionar uma caixa de mensagem para o manipulador de eventos Startup da pasta de trabalho.

Para adicionar uma caixa de mensagem a um evento de inicialização

Em Gerenciador de Soluções, clique com o botão direito do mouse de ThisWorkbook.vb ou ThisWorkbook.cse clique em Exibir Code no menu de atalho.

Adicionar o código a seguir ao manipulador de eventos Startup dentro da classe ThisWorkbook para mostrar uma caixa de mensagem durante a inicialização.

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.");
}

Pressionarionar F5 para executar o projeto.

Iniciar o Excel e a caixa de mensagem aparece.
Fechar a caixa de mensagem.
Excel Sair.

Criando um projeto de instalação

Projetos de instalação fornecem arquivos e código que você pode compilar para criar um arquivo do Windows Instalador para a solução.For more information, see Projetos de instalação.

Para criar um projeto de instalação para a solução

Clique com o botão direito do mouse o nó de solução em dGerenciador de Soluções.
Aponte para Adicionar no menu de atalho e, em seguida, clique em Novo projeto.

O Adicionar Novo Projeto caixa de diálogo é exibida.
No painel Projeto types, Expandirir Projeto outros tipos e Selecionar Instalação e implantação.
No painel modelos, Selecionar Instalação projeto.
Nomeie o projeto ExcelSetup.
Clique em OK.

O projeto de instalação aparece na Gerenciador de Soluções.Por padrão, o arquivo do Windows Instalador ComCompilaçãoá usando este projeto de instalação inclui uma caixa de diálogo que permite ao usuário final especificar o local de instalação da solução.For more information, see Caixa de diálogo instalação pasta User Interface.

Adicionando a pasta de trabalho e o assembly de solução ao projeto de instalação

A saída primária do projeto ExcelDeployment consiste na pasta de trabalho e o assembly de solução.Adicionar Esses componentes para o projeto de instalação.

Para adicionar o documento e o assembly ao projeto de instalação

Clique com o botão direito do mouse no ExcelSetup nó do projeto em Gerenciador de Soluções.
Aponte para do Exibir no menu de atalho e, em seguida, clique em do sistema de arquivos.
Clique com o botão direito de pasta de aplicativo de no Painel Esquerdo.
Aponte para Adicionar no menu de atalho e, em seguida, clique em Projeto Saída.
Selecionar ExcelDeployment na caixa Projeto.
Selecionar Principal saída na lista de tipos de saída.
Clique em OK.

A saída do projeto e dependências Aparecerr no painel direito.
Em Gerenciador de Soluções, Expandira Detectado dependências sob o nó de projeto ExcelSetup.
Clique com o botão direito do mouse cada dependência, exceto para o Microsoft .NET Framework e clique em Excluir no menu de atalho.

Criando um projeto de ação Personalizar

Ações Personalizars são um recurso do Windows Instalador.Você pode usá-los para executar o código ao final do processo de instalação para executar ações que não podem ser executadas durante a instalação.For more information, see Ações de Personalizar.

Para criar um projeto de ação Personalizar

Clique com o botão direito do mouse o nó de solução em dGerenciador de Soluções.
Aponte para Adicionar no menu de atalho e, em seguida, clique em Novo projeto.

O Adicionar Novo Projeto caixa de diálogo é exibida.
Na painel Projeto types, Expandirir o nó para a sua programação Idioma e Selecionar Windows.
No painel modelos, Selecionar De biblioteca de classes.
Nomeie o projeto ExcelCustomAction.
Clique em OK.

O novo projeto aparece na Gerenciador de Soluções.
Em Gerenciador de Soluções, clique com o botão direito do mouse Class1.vb ou Class1.cs no projeto ExcelCustomAction e clique em Excluir.Este arquivo é desnecessário para esta explicação passo a passo.

Criando uma ação Personalizar que edita o manifesto de aplicativo

Quando você executou o projeto anteriormente nesta explicação passo a passo pressionando de F5 de , o processo de compilação Editado o manifesto do aplicativo incorporado em pasta de trabalho para apontar para o caminho relativo do assembly.Se a pasta de trabalho e o assembly permanecem na mesma pasta após a instalação, em seguida, você não precisará modificar o manifesto do aplicativo incorporado e você pode ignorar esta seção.No entanto, se você quiser permitir que o usuário Mover a pasta de trabalho para uma pasta diferente depois de instalar a solução, em seguida, você deve editar o manifesto do aplicativo para apontar para o caminho completo do assembly.

Você deve atualizar o manifesto do aplicativo que está incorporado no documento Ferramentas do Visual Studio para o Office solução executando uma ação Personalizar após o processo de instalação é feito, porque o local do assembly solução é desconhecido até que o usuário Especifica o local durante a instalação.Editar o manifesto do aplicativo incorporado usando a classe ServerDocument.Usar a classe de ServerDocument em seu projeto de instalação, Adicionar código para uma classe de Installer dentro do projeto de ação Personalizar.

Para criar uma ação Personalizar que edita o manifesto do aplicativo

Clique com o botão direito do mouse no projeto de ExcelCustomAction na Gerenciador de Soluções.
Aponte para Adicionar no menu de atalho e, em seguida, clique em Novo item.

O Adicionar Novo Item caixa de diálogo é exibida.
Selecionar Classe de Instaladore nomeie a classe ManifestEditor.
Adicionar uma referência ao assembly ao projeto Microsoft.VisualStudio.Tools.Applications.Runtime ExcelCustomAction .
Em Gerenciador de Soluções, clique com o botão direito do mouse no ManifestEditor.cs ou ManifestEditor.vb arquivo e clique em Exibir Code.

Adicionar o seguinte Imports ou instrução de using para o início do arquivo código.

Imports Microsoft.VisualStudio.Tools.Applications.Runtime

using Microsoft.VisualStudio.Tools.Applications.Runtime;

Copiar o código a seguir na classe ManifestEditor.

Esse código substitui o método Install, que é usado para executar ações de instalação Personalizar.O código define o local de instalação especificado pelo usuário para a propriedade AssemblyPath.O Caminho da instalação especificado pelo usuário e os nomes do documento e o assembly são obtidos da propriedade 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();
        }
    }
}

Clique com o botão direito do mouse no projeto de ExcelCustomAction na Gerenciador de Soluçõese clique em Compilação.

Adicionar a ação Personalizar ao projeto instalação

Agora você pode habilitar o arquivo executar a ação Personalizar que edita o manifesto do aplicativo do Windows Instalador.Para fazer isso, Adicionar a saída primária do projeto ExcelCustomAction para o projeto de instalação.

Para adicionar a saída primária do projeto ação Personalizar para o projeto de instalação

Clique com o botão direito do mouse no ExcelSetup nó do projeto em Gerenciador de Soluções.
Aponte para do Exibir no menu de atalho e, em seguida, clique em Ações Personalizars.
No Personalizar Actions Editor, clique com o botão direito do mouse no nó de instalar e clique em Adicionar ação Personalizar.
Na caixa Examinar, Selecionar Da pasta de aplicativoe clique em Adicionar saída.
Selecionar ExcelCustomAction na caixa Projeto.
Selecionar Saída primária na lista de tipos de saída e clique em OK.
Verifique se Saída primária ExcelCustomAction (Ativo) foi Adicionado à lista de saída principal para o projeto de instalação e clique em OK.
No Personalizar Actions Editor, Expandirir Instalar.
Clique com o botão direito do mouse em **Primary Saída de ExcelCustomAction (ativo)**e clique em Janela Propriedades.
Na janela Propriedades , defina a propriedade de CustomActionData para a seguinte Cadeia de Caracteres.
```
/targetdir="[TARGETDIR]\" /documentname="ExcelDeployment.xls" /assemblyname="ExcelDeployment.dll"
```
Para obter informações sobre o CustomActionData propriedade, consulte Propriedade CustomActionData.
Clique com o botão direito de projeto de ExcelSetup em Gerenciador de Soluçõese clique em Compilação.

Testar o projeto.

Agora você pode testar o projeto para certificar-se de que sua solução está instalada ao executar o arquivo do Windows Instalador no seu computador de desenvolvimento.

Para testar o projeto

Clique com o botão direito de projeto de ExcelSetup em Gerenciador de Soluçõese clique em Executar.
Siga as instruções do Assistente de instalação e especificar uma pasta de instalação no seu computador de desenvolvimento.
Abrir a pasta de trabalho do Excel da pasta de instalação da.
Confirme se a caixa de mensagem aparece.

Consulte também

Partilhar via