Compartilhar via

Demonstra Passo a passo: Criar seu primeiro suplemento VSTO para Word

  • Artigo

Este passo a passo introdutório mostra como criar um suplemento VSTO para o Microsoft Office Word. Os recursos criados nesse tipo de solução estão disponíveis para o próprio aplicativo, independentemente de quais documentos estejam abertos.

Aplica-se a: As informações neste tópico se aplicam a projetos de suplemento VSTO para Word. Para obter mais informações, consulte Recursos disponíveis por aplicativo e tipo de projeto do Office.

Este passo a passo ilustra as seguintes tarefas:

  • Criando um projeto de suplemento VSTO do Word.

  • Escrever código que usa o modelo de objeto do Word para adicionar texto a um documento quando ele é salvo.

  • Construindo e executando o projeto para testá-lo.

  • Limpando o projeto concluído para que o suplemento VSTO não seja mais executado automaticamente no computador de desenvolvimento.

    Observação

    Seu computador pode mostrar diferentes nomes ou locais para alguns dos elementos de interface do usuário do Visual Studio nas instruções a seguir. A edição do Visual Studio que você possui e as configurações que você usa determinam esses elementos. Para obter mais informações, confira Personalizar o IDE.

Pré-requisitos

Você precisará dos seguintes componentes para concluir este passo a passo:

Criar o projeto

Para criar um novo projeto de suplemento VSTO do Word no Visual Studio

  1. Inicie o Visual Studio.

  2. No menu Arquivo , aponte para Novoe clique em Projeto.

  3. No painel de modelos, expanda Visual C# ou Visual Basic e, em seguida, expanda Office/SharePoint.

  4. No nó Office/SharePoint expandido, selecione o nó Suplementos do Office.

  5. Na lista de modelos de projeto, selecione um projeto de suplemento VSTO do Word.

  6. Na caixa Nome, digite FirstWordAddIn.

  7. Clique em OK.

    Visual Studio cria o projeto FirstWordAddIn e abre o arquivo de código ThisAddIn no editor.

Escrever código para adicionar texto ao documento salvo

Em seguida, adicione código ao arquivo de código ThisAddIn. O novo código usa o modelo de objeto do Word para adicionar texto clichê a cada documento salvo. Por padrão, o arquivo de código ThisAddIn contém o seguinte código gerado:

  • Uma definição parcial da ThisAddIn classe. Essa classe fornece um ponto de entrada para seu código e fornece acesso ao modelo de objeto do Word. Para obter mais informações, consulte Suplementos do programa VSTO. O restante da classe é definido em um arquivo de ThisAddIn código oculto que você não deve modificar.

  • Os ThisAddIn_Startup manipuladores de eventos e ThisAddIn_Shutdown . Esses manipuladores de eventos são chamados quando o Word carrega e descarrega o suplemento VSTO. Use esses manipuladores de eventos para inicializar o suplemento VSTO quando ele for carregado e para limpar os recursos usados pelo suplemento VSTO quando ele for descarregado. Para obter mais informações, consulte Eventos em projetos do Office.

Para adicionar um parágrafo de texto ao documento salvo

  1. No arquivo de código ThisAddIn, adicione o seguinte código à ThisAddIn classe. O novo código define um manipulador de eventos para o DocumentBeforeSave evento, que é gerado quando um documento é salvo.

    Quando o usuário salva um documento, o manipulador de eventos adiciona novo texto no início do documento.

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

    Observação

    Esse código usa um valor de índice de 1 para acessar o primeiro parágrafo da Paragraphs coleção. Embora o Visual Basic e o Visual C# usem matrizes baseadas em 0, os limites inferiores da matriz da maioria das coleções no modelo de objeto do Word é 1. Para obter mais informações, consulte Escrever código em soluções do Office.

  2. Se você estiver usando C#, adicione o seguinte código necessário ao manipulador de ThisAddIn_Startup eventos. Esse código é usado para conectar o manipulador de eventos com o Application_DocumentBeforeSaveDocumentBeforeSave evento.

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

    Para modificar o documento quando ele é salvo, os exemplos de código anteriores usam os seguintes objetos:

  • O Application campo da ThisAddIn classe. O Application campo retorna um Application objeto, que representa a instância atual do Word.

  • O Doc parâmetro do manipulador de eventos para o DocumentBeforeSave evento. O Doc parâmetro é um Document objeto, que representa o documento salvo. Para obter mais informações, consulte Visão geral do modelo de objeto do Word.

Testar o projeto

Para testar o projeto

  1. Pressione F5 para compilar e executar seu projeto.

    Quando você compila o projeto, o código é compilado em um assembly que está incluído na pasta de saída de compilação para o projeto. O Visual Studio também cria um conjunto de entradas do Registro que permitem que o Word descubra e carregue o suplemento VSTO e define as configurações de segurança no computador de desenvolvimento para permitir que o suplemento VSTO seja executado. Para obter mais informações, consulte Criar soluções do Office.

  2. No Word, salve o documento ativo.

  3. Verifique se o texto a seguir foi adicionado ao documento.

    Este texto foi adicionado usando código.

  4. Feche o Word.

Limpar o projeto

Quando terminar de desenvolver um projeto, remova o assembly do suplemento VSTO, as entradas do Registro e as configurações de segurança do computador de desenvolvimento. Caso contrário, o suplemento VSTO continuará a ser executado sempre que você abrir o Word no computador de desenvolvimento.

Para limpar o projeto concluído no computador de desenvolvimento

  1. No Visual Studio, no menu Compilar , clique em Limpar Solução.

Próximas etapas

Agora que você criou um suplemento básico do VSTO para o Word, você pode aprender mais sobre como desenvolver suplementos do VSTO a partir destes tópicos:

  • Tarefas gerais de programação que você pode executar em Suplementos VSTO: Suplementos VSTO do Programa.

  • Tarefas de programação específicas para suplementos VSTO do Word: soluções do Word.

  • Usando o modelo de objeto do Word: Visão geral do modelo de objeto do Word.

  • Personalizar a interface do usuário do Word, por exemplo, adicionando uma guia personalizada à Faixa de Opções ou criando seu próprio painel de tarefas personalizado: personalização da interface do usuário do Office.

  • Criando e depurando suplementos VSTO para Word: crie soluções do Office.

  • Implantando suplementos VSTO para Word: implante uma solução do Office.

Conteúdo relacionado